Bagaimana cara mendokumentasikan fungsi dan alias bash khusus saya?

Masalah:

Saya memiliki beberapa fungsi bash dan alias. Saya tidak dapat mengingat semuanya di atas kepala saya, jadi saya biasanya membuka file .bash_functionsdan .bash_aliasesfile saya untuk menemukan yang saya butuhkan.

Pertanyaan:

Bagaimana saya bisa membuat daftar fungsi / alias yang tersedia dari bash prompt?

Apakah mungkin bagi saya untuk mendokumentasikan fungsi / alias bash saya menggunakan komentar (agak seperti PHPDoc)?

Saya hanya ingin cara sederhana / bagus untuk menampilkan apa yang tersedia tanpa harus membuka file. Akan lebih keren untuk menjalankan perintah dan memintanya mengeluarkan daftar dinamis fungsi / alias saya (contoh penggunaan akan menjadi nilai tambah). :)

Untuk daftar alias aktif, jalankan:

alias

Untuk melihat nama semua fungsi yang aktif, jalankan:

declare -F

Untuk melihat nama dan definisi semua fungsi yang aktif, jalankan:

declare -f

Lebih

Informasi tentang alias juga tersedia adalah format script-friendly dengan:

declare -p BASH_ALIASES

man bashmemberikan info lebih lanjut tentang aliasbuiltin:

   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.

Mengenai fungsi, man bashjelaskan bahwa declaremasih dapat memberikan lebih banyak informasi tersedia jika extdebugopsi disetel:

   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).

Tautan

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

Saya menggunakan fungsi berikut dan javadoc seperti komentar untuk membuat opsi --help untuk skrip saya:

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;
}

Di https://github.com/kaspervandenberg/aida/blob/master/Search/zylabPatisClient/src/main/scripts/generateReport.sh Anda dapat melihat bagaimana ini digunakan dalam skrip aktual.