PowerShell Tip #2 from the Winner of the Advanced Category in the 2013 Scripting Games
Tip #2 - Comment (Document) your code!
This is another one of those tips that probably isn’t very popular, but regardless of how good you are at writing PowerShell scripts and functions, they’re useless if no one else can figure out how to use them. You might be thinking that you’re the only one who uses the PowerShell code that you write, but I’m sure that you like to go on vacation just like the rest of us and none of us are going to live forever.
In my tip #1 blog you learned that you need to “Read the Help!”. This tip builds on the first one because it allows others to “Read the Help!” for the PowerShell code that you write.
The type of help that you want to provide for your PowerShell functions and scripts is “Comment Based Help”. Click here to be redirected to the original post of this article on the author’s blog site where you can read the remainder of the article.
µ
Related Articles
Iron Scripter prequels: Puzzle 10 – A commentary
This is the commentary on the last Iron Scripter prequel puzzle: Iron Scripter Prequel Puzzle 10 - A commentary
Next weekend will mark the start of summit and you can work on the Iron Scripter preludes - 4 daily puzzles as a lead in to the main event on Thursday 12 April 2018. If you haven’t chosen your faction yet you need to hurry
Iron Scripter Prequels: Puzzle 9 – A commentary
Here’s my commentary for puzzle 9: Iron Scripter Prequel Puzzle 9 - A commentary
In this puzzle you were cleaning up the TEMP folder and the recycle bin plus working with scheduled tasks and/or scheduled jobs.
One more commentary to come - probably early next week rather than Sunday and then we’re into the Summit and the main event.
Iron Scripter Preludes and Main Event: Rules and Info
Information is now available at IronScripter.us for the at-Summit events, and participants are advised to refresh themselves on the Rules.
Participants attending Summit should begin choosing their faction and getting to know their teammates in the faction-specific channels of the DevOps-Summit Slack team (open only to attendees and alumni).
Participants hoping to participate remotely may wish to start choosing a faction and finding a way to get in touch with them. The Faction Discussion may be a good way to do that.