Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Powershell 5: documentation support via comments for classes and enums members

Just wondering whether there is any support for comments considered as documentation for enums and classes members (methods and fields / properties) in PowerShell?

like image 891
Natalie Perret Avatar asked May 08 '17 17:05

Natalie Perret


1 Answers

If you're referring to the equivalent of Comment-Based Help, I've seen no indication of any. However, if you're writing classes or enums, you are also presumably writing scripts or script cmdlets/advanced functions that rely on them; it wouldn't be unreasonable to document the classes or enums in the scripts/etc. that use them.

Trevor Sullivan provides a link below to building your own about_Topic help data files; this represents another possibility, and one that may well be more appropriate, depending on how you're using your classes/enums.

like image 184
Jeff Zeitlin Avatar answered Nov 07 '22 09:11

Jeff Zeitlin