On Friday, December 16, 2016, I posted the following puzzle on Twitter. It shows a function that has no comment-based help or XML help, but when you run Get-Help on the function, Get-Help displays both a description and notes for the function. What is the source of help for this function? I call this unintentional […]
Tag: comment based help
Writing Help for Dynamic Parameters
Because dynamic parameters can be added to a command from multiple sources, the command author (who writes the help) cannot predict the dynamic parameters that might be available at runtime. Therefore, Get-Help expects dynamic parameters to be documented in the help file for the code that adds the dynamic parameters; not the code that has […]
PowerShell Studio 2014: Editing Functions
We improved the Function Builder yet again! Man, when are you guys going to stop this? Never. With the 4.1.71 build of PowerShell Studio 2014, you now have the option to edit existing functions within the Function Builder! Ok cool, how do I edit my existing functions? Simple, you can edit existing functions using the […]
PowerShell Studio 2014: Comment-Based Help Templates
In a previous article we covered how you can generate comment-based help for functions. Now we expanded upon this feature by added the ability to create templates for comment-based help generator. [Requires: PowerShell Studio 2014 v4.1.61 or above] Comment-Based Help Templates PowerShell Studio comes with a predefined template that contains the following: The template file […]
PowerShell Studio 2014: Comment Based Help
Previously, when creating comment based help in PowerShell Studio 2012, you either had to manually add the help comment or use the built-in comment based help snippet. The snippets worked well but you were still required to manually add each parameter of the function which takes time and there are better ways we would rather […]
