カスタムbash関数とエイリアスを文書化する方法は？

問題：

複数のbash関数とエイリアスがあります。頭の上にあるものすべてを覚えているわけではないので、たいていの場合.bash_functions、.bash_aliasesファイルを開いて必要なものを見つけます。

質問：

bashプロンプトから使用できる関数/エイリアスを一覧表示するにはどうすればよいですか？

コメント（PHPDocのようなもの）を使用してbash関数/エイリアスを文書化することは可能ですか？

ファイルを開かずに、利用できるものを出力する簡単で便利な方法が欲しいのですが。コマンドを実行して、関数/エイリアスの動的リストを吐き出させると便利です（使用例はプラスです）。:)

アクティブなエイリアスを一覧表示するには、次のコマンドを実行します。

alias

すべてのアクティブな関数の名前を表示するには、次を実行します。

declare -F

すべてのアクティブな関数の名前と定義を表示するには、次を実行します。

declare -f

もっと

エイリアスに関する情報も利用可能で、スクリプトに適した形式です。

declare -p BASH_ALIASES

man bashalias組み込みの詳細情報を提供します：

   alias [-p] [name[=value] ...]
          Alias with  no  arguments  or  with  the  -p
          option  prints  the  list  of aliases in the
          form alias name=value  on  standard  output.
          When  arguments  are  supplied,  an alias is
          defined for each name whose value is  given.
          A  trailing  space in  value causes the next
          word to be checked  for  alias  substitution
          when  the  alias is expanded.  For each name
          in the argument list for which no  value  is
          supplied, the name and value of the alias is
          printed.  Alias returns true unless  a  name
          is   given  for  which  no  alias  has  been
          defined.

機能に関して、オプションが設定されている場合、さらに多くの情報を提供できることがman bash説明されてdeclareいextdebugます。

   Function  names  and definitions may be listed with
   the -f option to the  declare  or  typeset  builtin
   commands.  The -F option to declare or typeset will
   list the function names only  (and  optionally  the
   source  file and line number, if the extdebug shell
   option is enabled).

リンク集

1. http://ss64.com/bash/alias.html
2. http://linfo.org/alias.html

次の関数とjavadocのようなコメントを使用して、スクリプトの--helpオプションを作成します。

PROG=$0 #The program name, used within doHelp

# Print a help message
# doHelp uses lines starting with ## to create the output
# the tags {@param ...} and {@code ...} colorize words
doHelp() {
grep '^##' "${PROG}" |
sed -e 's/^##[[:space:]]*//' |
while read line; do
    if ( echo "${line}" | grep -q '{@param [^}]*}' ); then
        # color parameter and echo evaulated value
        eval echo -e $(echo ${line} | sed \
            -e 's/^\(.*\){@param \([^}]*\)}\(.*\)$/\
            \"\1\\\\E[32;40m\2\\\\E[37;40m\\t(value: \"$\2\")\3\"/');
    else
        # other color commands
        echo -e $(echo ${line} | sed \
            -e 's/{@code \([^}]*\)}/\\E[36;40m\1\\E[37;40m/g');
    fi
done;
}

でhttps://github.com/kaspervandenberg/aida/blob/master/Search/zylabPatisClient/src/main/scripts/generateReport.shあなたはそれが実際のスクリプト内で使われているかを見ることができます。