사용자 정의 bash 함수 및 별명을 문서화하는 방법은 무엇입니까?

문제:

bash 함수와 별칭이 여러 개 있습니다. 난 보통 내 개방 결국 그래서 나는 내 머리 위로 떨어져 그들 모두를 기억할 수 .bash_functions와 .bash_aliases내가 필요한 것을 찾기 위해 파일을.

질문 :

bash 프롬프트에서 사용 가능한 함수 / 별칭을 어떻게 나열합니까?

주석 (PHPDoc과 같은 Kinda)을 사용하여 bash 함수 / 별명을 문서화 할 수 있습니까?

파일을 열지 않고도 사용 가능한 것을 출력하는 간단하고 좋은 방법을 원합니다. 명령을 실행하고 내 기능 / 별칭의 동적 목록을 뱉어내는 것이 좋습니다 (사용 예는 플러스 일 것입니다). :)

활성 별명을 나열하려면 다음을 실행하십시오.

alias

모든 활성 기능의 이름을 보려면 다음을 실행하십시오.

declare -F

모든 활성 기능의 이름과 정의를 보려면 다음을 실행하십시오.

declare -f

더

별칭에 대한 정보는 다음과 같은 스크립트 친화적 형식입니다.

declare -p BASH_ALIASES

man bashalias내장 에 대한 자세한 정보를 제공합니다.

   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설명합니다 .declareextdebug

   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 당신이 실제 스크립트에서 사용되는 방법을 볼 수 있습니다.