Come documentare le mie funzioni e alias bash personalizzati?

Problema:

Ho più funzioni e alias bash. Non riesco a ricordare tutti loro dalla parte superiore della mia testa, quindi di solito finisco per aprire il mio .bash_functionse .bash_aliasesfile per trovare quello che mi serve.

Domande):

Come posso elencare funzioni / alias disponibili dal prompt di bash?

Posso documentare le mie funzioni / alias bash usando i commenti (un po 'come PHPDoc)?

Vorrei solo un modo semplice / carino per produrre ciò che è disponibile senza dover aprire i file. Sarebbe bello eseguire un comando e farlo sputare un elenco dinamico delle mie funzioni / alias (gli esempi di utilizzo sarebbero un vantaggio). :)

Per elencare gli alias attivi, eseguire:

alias

Per vedere i nomi di tutte le funzioni attive, eseguire:

declare -F

Per vedere i nomi e le definizioni di tutte le funzioni attive, eseguire:

declare -f

Di Più

Le informazioni sugli alias sono anche disponibili in un formato intuitivo con:

declare -p BASH_ALIASES

man bashfornisce maggiori informazioni sull'integrato alias:

   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.

Per quanto riguarda le funzioni, man bashspiega che è declarepossibile fornire ulteriori informazioni se l' extdebugopzione è impostata:

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

link

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

Uso la seguente funzione e javadoc come commenti per creare un'opzione --help per i miei script:

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

A https://github.com/kaspervandenberg/aida/blob/master/Search/zylabPatisClient/src/main/scripts/generateReport.sh puoi vedere come viene utilizzato all'interno di uno script reale.