In principle, we can distinguish between two types: Comment-Based Help for Functions and for Scripts. ![]() These comments have to be arranged and formatted correctly – you’ll find out exactly how in this section. The magic word for our project is Comment-Based Help.Īs the name suggests, this method allows us to generate help information through comments. In this article, I’ll show you how to use meta-data to get script information via Get-Help. ![]() Furthermore, additional notes can be added to code snippets – for example, if a function is to be extended by further features.īut beyond this pure information content, comments in PowerShell, used correctly, can be used for help articles about your functions. Surely you already use comments within your PowerShell scripts, and surely you too have been annoyed by uncommented scripts.Ĭomments in PowerShell scripts make it possible to document certain processes directly in the code.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |