bash - Bash 行注释继续

Question

我看到一些 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 样式的注释来自动生成文档）？

这是一种常见的做法吗？我知道包含/排除它并没有什么坏处，就实际脚本执行而言，但我很好奇采用这种评论风格是否有好处。

Answer 1

根据Advanced Bash-Scripting Guide，看起来这是可以用来提高脚本清晰度和易读性的几个注释标题之一。此花絮在指南的“各种提示”部分中介绍：

使用特殊用途的注释标题来提高脚本的清晰度和易读性。

以下是他们在指南的示例块中列出的几个：

## 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"

显然有些人觉得这些小技巧很有帮助，但我个人认为这样做并没有多大好处。