วิธีจัดทำฟังก์ชั่นทุบตีและนามแฝงที่กำหนดเองของฉัน

ปัญหา:

ฉันมีฟังก์ชั่นทุบตีและชื่อแทนหลายรายการ ฉันจำไม่ได้ว่าพวกเขาทั้งหมดอยู่ด้านบนของหัวของฉันดังนั้นฉันมักจะเปิดท้ายของฉัน.bash_functionsและ.bash_aliasesไฟล์เพื่อค้นหาสิ่งที่ฉันต้องการ

คำถาม (s):

ฉันจะแสดงรายการฟังก์ชั่น / นามแฝงที่มีอยู่จาก bash prompt ได้อย่างไร?

เป็นไปได้ไหมที่ฉันจะทำเอกสารฟังก์ชั่นทุบตี / นามแฝงของฉันโดยใช้ความคิดเห็น (kinda เช่น PHPDoc)?

ฉันแค่ต้องการวิธีที่ง่าย / ดีในการแสดงผลสิ่งที่มีอยู่โดยไม่ต้องเปิดไฟล์ มันจะเจ๋งมากในการรันคำสั่งและปล่อยให้มันมีรายการแบบไดนามิกของฟังก์ชั่น / ชื่อแทนของฉัน (ตัวอย่างการใช้งานจะเป็นบวก) :)

ในการแสดงชื่อแทนที่ใช้งานอยู่ให้รัน:

alias

หากต้องการดูชื่อของฟังก์ชั่นที่ใช้งานอยู่ให้รัน:

declare -F

หากต้องการดูชื่อและคำจำกัดความของฟังก์ชั่นที่ใช้งานอยู่ทั้งหมดให้เรียกใช้:

declare -f

มากกว่า

ข้อมูลเกี่ยวกับนามแฝงยังมีอยู่ในรูปแบบที่เป็นมิตรกับสคริปต์ด้วย:

declare -p BASH_ALIASES

man bashให้ข้อมูลเพิ่มเติมเกี่ยวกับaliasbuiltin:

   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 ชอบความคิดเห็นเพื่อสร้างตัวเลือก - ช่วยสำหรับสคริปต์ของฉัน:

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คุณสามารถดูว่ามีการใช้งานอย่างไรภายในสคริปต์จริง