背景
たとえば、Pythonスクリプトは、次のような方法で複数の「レベル」のドキュメントを持つことができます。docstrings素晴らしいのは、関数レベル、メソッドレベル、クラスレベル、そして最も重要な点 (私の質問の文脈では)、ファイルレベルごとに定義できることです。たとえば、ファイルの先頭は次のようになります。
#!/usr/bin/env python
"""
@brief A script that does cool stuff.
"""
この機能の特に便利な点は、実行時に簡単に抽出して印刷できることです。
質問
するバッシュスクリプトはそのような機能をサポートしていますか？つまり、ファイルレベルのドキュメントセット（つまり、スクリプトの目的を人間が読める形で記述したもの）を生成するための「標準化された」アプローチはありますか？usage構文など、別のスクリプトでこの情報を自動的に解析/抽出することが容易になりますか?私の目標は、自己文書化されているデバッグ スクリプトをいくつか作成することです。これを行うための標準的/事実上の最善の方法がすでにある場合は、車輪の再発明を避けたいと思います。
ベストアンサー1
Googleの「ファイルヘッダー」セクションシェルスタイルガイドbash スクリプトに 'docstring' を追加する 1 つの方法です。
基本的に、答えは#、Python のように引用符ではなく、 を使用することです。