Comment créer des commentaires descriptifs PowerShell

PowerShell Scripting prend en charge les commentaires afin d'ajouter des instructions lisibles par l'homme. Plus précisément, des commentaires sont ajoutés au script à des fins de débogage et de documentation. Ces commentaires descriptifs aident les autres programmeurs à comprendre le code plus clairement. Les commentaires descriptifs pourraient être des commentaires en une seule ligne ou en ligne.

Cet article discutera de plusieurs méthodes pour créer des commentaires descriptifs.

Comment créer des commentaires descriptifs PowerShell?

Dans PowerShell, les commentaires descriptifs peuvent être créés en utilisant les méthodes mentionnées ci-dessous:

• Commentaires descriptifs à une seule ligne.
• Commentaires descriptifs multilines.

Méthode 1: commentaires descriptifs à une seule ligne

Des commentaires en une seule ligne peuvent être créés pour ajouter des descriptions de code à l'aide du «#" hashtag. Le texte écrit aux côtés du hashtag sera considéré comme le commentaire. Ces commentaires sont utilisés pour ajouter des descriptions de code mineures.

Exemple
Cet exemple montrera pour ajouter un commentaire de ligne unique dans le script PowerShell:

# C'est un commentaire unique.
Le commentaire descriptif de l'écriture "ne s'affiche pas."
# Commentaire descriptif de ligne unique

Selon le code ci-dessus:

• Tout d'abord, créez un commentaire unique en utilisant le "#" hashtag.
• Après cela, spécifiez le «Hôte d'écriture”Cmdlet pour ajouter une ligne de chaîne.
• Enfin, ajoutez le commentaire unique:

On peut observer que le commentaire descriptif à une seule ligne a été ajouté avec succès et qu'il ne s'est pas affiché dans la console PowerShell.

Méthode 2: commentaires descriptifs multilines

Les commentaires semblent bien lorsqu'ils sont courts et concis, mais il est nécessaire d'écrire des commentaires descriptifs détaillés. Ces commentaires sont appelés les blocs multilignes ou commentaires. Plus précisément, les commentaires multilines ou les blocs de commentaires commencent par ce symbole "<#"Et finir avec ce"#>" symbole. Tout ce qui est écrit à l'intérieur de ces symboles sera considéré comme des commentaires descriptifs multi-lignes.

Exemple
Cet exemple illustrera la création des commentaires multilines dans PowerShell:

<# Description
du code
peut être ajouté ici
#>
Écriture-host "Ceci est un exemple de commentaire en plusieurs lignes."

Selon le code ci-dessus:

• Tout d'abord, ajoutez le commentaire multiligne dans le démarrage "<#"Et terminant"#>”Symboles.
• Après cela, nous avons ajouté le "Hôte d'écriture”Cmdlet pour ajouter une ligne de chaîne:

Le commentaire descriptif multi-lignes a été ajouté avec succès, et il ne s'est pas affiché dans la console PowerShell.

Conclusion

Le commentaire descriptif dans PowerShell peut être créé à l'aide de commentaires à ligne unique et multiple. Les commentaires uniques peuvent être créés en ajoutant le hashtag "#”Hashtag au début de la ligne. Alors que les commentaires multiples sont créés à l'intérieur du «<#"Démarrage et le"#>”Fin des symboles. Ce blog a élaboré un guide détaillé pour créer des commentaires descriptifs PowerShell.