Jak udokumentować moje niestandardowe funkcje i aliasy bash?

Problem:

Mam wiele funkcji i aliasów bash. Nie pamiętam ich wszystkich z głowy, więc zwykle otwieram pliki .bash_functionsi .bash_aliasespliki, aby znaleźć to, czego potrzebuję.

Pytania):

Jak mogę wyświetlić listę funkcji / aliasów dostępnych w wierszu poleceń bash?

Czy mogę udokumentować moje funkcje / aliasy bash przy użyciu komentarzy (trochę jak PHPDoc)?

Chciałbym po prostu w prosty / przyjemny sposób wyprowadzić to, co jest dostępne, bez konieczności otwierania plików. Fajnie byłoby uruchomić polecenie i wyrzucić dynamiczną listę moich funkcji / aliasów (przykłady użycia byłyby plusem). :)

Aby wyświetlić listę aktywnych aliasów, uruchom:

alias

Aby zobaczyć nazwy wszystkich aktywnych funkcji, uruchom:

declare -F

Aby zobaczyć nazwy i definicje wszystkich aktywnych funkcji, uruchom:

declare -f

Więcej

Dostępne są również informacje o aliasach w formacie przyjaznym dla skryptów z:

declare -p BASH_ALIASES

man bashzapewnia więcej informacji na temat aliaswbudowanego:

   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 bashWyjaśnia to w odniesieniu do funkcjideclare może dostarczyć jeszcze więcej informacji, jeśli extdebugjest ustawiona opcja:

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

Spinki do mankietów

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

Używam następującej funkcji i komentarzy typu javadoc, aby utworzyć opcję --help dla moich skryptów:

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

Na https://github.com/kaspervandenberg/aida/blob/master/Search/zylabPatisClient/src/main/scripts/generateReport.sh możesz zobaczyć, jak jest używany w rzeczywistym skrypcie.