Як документувати власні функції bash та псевдоніми?

Проблема:

У мене є кілька функцій bash та псевдонімів. Я не можу згадати їх усіх у верхній частині голови, тому я, як правило, відкриваю свої файли .bash_functionsта .bash_aliasesфайли, щоб знайти те, що мені потрібно.

Питання:

Як я можу перерахувати функції / псевдоніми, доступні у запиті bash?

Чи можна мені документувати мої функції bash / псевдоніми за допомогою коментарів (начебто PHPDoc)?

Я просто хотів би простий / приємний спосіб вивести доступне без необхідності відкривати файли. Було б здорово запустити команду і запропонувати їй виписати динамічний список моїх функцій / псевдонімів (приклади використання були б плюсом). :)

Щоб перелічити активні псевдоніми, запустіть:

alias

Щоб побачити імена всіх активних функцій, запустіть:

declare -F

Щоб побачити імена та визначення всіх активних функцій, запустіть:

declare -f

Більше

Інформація про псевдоніми також доступна в зручному для сценарію форматі:

declare -p BASH_ALIASES

man bashнадає більше інформації про 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.

Щодо функцій, 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 ви можете побачити, як він використовується в реальному сценарії.