Bash言語には、関数のコメントが関数の前に置かれるのか、それとも関数の中に置かれるべきかを規定する標準はありますか?私は2つの方法で書かれたスクリプトを見たことがあります。
# Comment preceding function.
func1(){
echo "example"
}
-または-
func2() {
# Comment inside of function
echo "example"
}
答え1
ほとんどのプログラミング言語では、関数が実行する操作を説明するコメントが関数の前にあります。おそらくbashでも同じことをする必要があります。インデントも使用する必要があります。
# function 1 comment
func1() {
echo "example"
}
答え2
これはい式からバッシュストアコメント今後関数ヘッダも同様です。 https://github.com/scop/bash-completion。
今から6ヶ月後にリファクタリングする人(おそらくあなた)が解読しにくい限り、それは重要ではないと思います。
シェルにコメントを追加するもう1つの方法は次のとおりです。
:<<'DOC'
My
multi
line
comment
DOC
インデントそして一貫性また、一般的に持っていれば良いです。