Comment documenter mes fonctions et alias bash personnalisés?

Problème:

J'ai plusieurs fonctions et alias bash. Je ne me souviens pas tous d'eux du haut de ma tête, donc je finis généralement par ouvrir mes fichiers .bash_functionset .bash_aliasespour trouver ce dont j'ai besoin.

Des questions):

Comment puis-je répertorier les fonctions / alias disponibles à partir de l'invite bash?

Est-il possible pour moi de documenter mes fonctions / alias bash en utilisant des commentaires (un peu comme PHPDoc)?

Je voudrais juste un moyen simple / agréable de sortir ce qui est disponible sans avoir à ouvrir les fichiers. Ce serait cool d'exécuter une commande et de lui faire cracher une liste dynamique de mes fonctions / alias (des exemples d'utilisation seraient un plus). :)

Pour répertorier les alias actifs, exécutez:

alias

Pour voir les noms de toutes les fonctions actives, exécutez:

declare -F

Pour voir les noms et définitions de toutes les fonctions actives, exécutez:

declare -f

Plus

Les informations sur les alias sont également disponibles sous forme de script avec:

declare -p BASH_ALIASES

man bashfournit plus d'informations sur la fonction aliasintégrée:

   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.

En ce qui concerne les fonctions, man bashexplique que declarepeut fournir encore plus d'informations est disponible si l' extdebugoption est définie:

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

Liens

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

J'utilise la fonction suivante et javadoc comme des commentaires pour créer une option --help pour mes scripts:

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

Sur https://github.com/kaspervandenberg/aida/blob/master/Search/zylabPatisClient/src/main/scripts/generateReport.sh, vous pouvez voir comment il est utilisé dans un script réel.