Comment-based help

Versions

[{“Name”:“2.0”,“GroupName”:null},{“Name”:“3.0”,“GroupName”:null},{“Name”:“4.0”,“GroupName”:null},{“Name”:“5.0”,“GroupName”:null},{“Name”:“5.1”,“GroupName”:null}]

Introduction

PowerShell features a documentation mechanism called comment-based help. It allows documenting scripts and functions with code comments. Comment-based help is most of the time written in comment blocks containing multiple help keywords. Help keywords start with dots and identify help sections that will be displayed by running the Get-Help cmdlet.