Bash продолжение комментария строки

Я видел, что некоторые комментарии bash/shell используют обозначение

#  Some comment block that stars on line 1, but then
#+ continue on line two with this silly plus sign.

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

Помогает ли "# +" с любым видом парсера (например, как комментарии стиля Doxygen используются для автоматической генерации документации)?

Это обычная практика? Я понимаю, что это не повредит чему-либо, чтобы включить/исключить его, если фактическое выполнение script выполняется, но мне любопытно, есть ли преимущества для принятия этого стиля комментариев.

Ответы

Ответ 1

В соответствии с Расширенным 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"

По-видимому, некоторые люди находят эти маленькие бит полезными, но я лично не вижу большой пользы в этом.