Bonjour,
Does anyone here has any hint about what’s the “official” format for comment-based help for INPUTS and OUTPUTS? I noticed while trying to use PlatyPS that whatever format I use, it ends up as a type called “TYPE Description”. Apparently, everything I type ends up as a single string in (Get-Help Get-MyInfo).PSObject.properties[‘InputTypes’].Value …
Is there any way to properly separate type names and their description?
Thanks for any light…
As for …
Does anyone here has any hint about what's the "official" format for comment-based help for INPUTS and OUTPUTS?
Do you mean beyond what MS has stated.
https://docs.microsoft.com/en-us/powershell/developer/help/comment-based-help-keywords
Others have their take…
… but you need to use what works for you or what you are required to use by your management.
I mean beyond that indeed. Those pages were the starting point of my search and they all use the very same sentence: “The .NET Framework type of the objects that the cmdlet returns. You can also include a description of the returned objects.”
My question is: what is the format that the help system is expecting for the type and description?