PowerShell Code documentation

PowerShell Help
1

Hello All,

I have a rather large script/modules that I have been asked to document. They want something more then comments and comment based help. The preferred would be HTML format. A google search led me here:

I do believe this is exactly what I need, however I am unable to get it working. It always errors that no “NameSpaces” are found. Does anyone out there have any experience with this tool and if so, any ideas on what I am doing wrong?

Secondly, are there better tools that provide similar results?

Thanks in advanced for any help/guidance.

2

You can try exploring markdown files. It can be rendered as html page as well. Sharepoint and other similar platforms supports markdown files by default.
You can even generate markdown help docs for PowerShell script/cmdlet/function automatically using GitHub - PowerShell/platyPS: Write PowerShell External Help in Markdown

3

@kvprasoon … thank you very much. That worked perfectly :slight_smile: