13

いくつかの bash/shell コメントが表記法を使用しているのを見てきました

#  Some comment block that starts on line 1, but then
#+ continues on line 2 with this silly plus sign.

#  And this is another comment line that is not related to the ones above

"#+" は、どのような種類のパーサーにも役立ちますか (Doxygen スタイルのコメントを使用してドキュメントを自動生成する方法など)?

これは一般的な方法ですか？実際のスクリプトの実行に関する限り、それを含めたり除外したりしても害がないことは理解していますが、このスタイルのコメントを採用することに利点があるかどうか知りたいです。

4

1 に答える 1

7

Advanced Bash-Scripting Guideによると、これは、スクリプトの明瞭さと読みやすさを向上させるために使用できるいくつかのコメント ヘッダーの 1 つです。このちょっとした情報は、ガイドの「さまざまなヒント」セクションに記載されています。

特別な目的のコメント ヘッダーを使用して、スクリプトの明確さと読みやすさを向上させます。

ガイドの例のブロックにリストされているもののいくつかを次に示します。

## Caution.
rm -rf *.zzy   ##  The "-rf" options to "rm" are very dangerous,
               ##+ especially with wild cards.

#+ Line continuation.
#  This is line 1
#+ of a multi-line comment,
#+ and this is the final line.

#* Note.

#o List item.

#> Another point of view.
while [ "$var1" != "end" ]    #> while test "$var1" != "end"

どうやらこれらのちょっとしたことが役立つと思う人もいますが、個人的にはそれをすることにあまりメリットがないと思います.

于 2012-08-28T20:21:21.807 に答える