☰

Bash 函数在函数之前或内部注释

tag-icon • tag-icon bash shell-script shell
Bash 函数在函数之前或内部注释

Bash 语言是否有一个标准来规定关于函数​​的注释是应该放在函数之前还是放在函数内部。我见过两种方式编写的脚本。

# Comment preceding function.
func1(){
echo "example"
}

-或者-

func2() {
# Comment inside of function
echo "example"
}

答案1

在大多数编程语言中，描述函数功能的注释位于函数之前。您可能应该对 bash 做同样的事情。您还应该使用缩进：

# function 1 comment
func1() {
    echo "example"
}

答案2

这例子来自官方bash 仓库评论前函数头也是如此 https://github.com/scop/bash-completion。

我认为这并不重要，只要它对 6 个月后将重构它的人（可能是你）来说仍然非常容易破译即可。

这是在 shell 中评论的另一种方法：

:<<'DOC'
My 
multi 
line
comment
DOC

缩进和一致性一般来说也很高兴拥有。

相关内容