призначити та перевірити метадані функції bash

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

Я хочу анотувати функції таким чином, щоб інформація про проект, який вони були створені, таким чином:

func1() {
# This function was generated for project: PROJECT1
echo "do my automation"
}

В ідеалі я міг би побачити коментар, коли перевіряю визначення:

$ type func1

func1 is a function
func1 () 
{
    # This function was generated for project: PROJECT1
    echo "do my automation"
}

Але якось bash, здається, ігнорує коментарі в момент завантаження функції, а не при її виконанні. Так що коментарі втрачені, і я отримую такий результат:

func1 is a function
func1 () 
{
    echo "do my automation"
}

Чи є спосіб призначити метадані функції та перевірити їх після цього? Можна отримати його під час перевірки визначення з типом?

function func_name()
{
  : '
  Invocation:   func_name $1 $2 ... $n
  Function:     Display the values of the supplied arguments, in double quotes.
  Exit status:  func_name always returns with exit status 0.
  ' :
  local i
  echo "func_name: $# arguments"
  for ((i = 1; i <= $#; ++i)); do
    echo "func_name [$i] \"$1\""
    shift
  done
  return 0
}

Так, typeздається, роздруковується лише частини функції, яка буде запущена. Мені це здається розумним, адже, як правило, це все, що вам цікаво під час запитів type.

Для вирішення замість коментарів додайте метадані так:

func1() {
    meta="This function was generated for project: PROJECT1"
    echo "do my automation"
}

Ніколи не потрібно реально використовувати цю змінну, але вона з’явиться при запиті функції за допомогою type:

$ type func1
func1 is a function
func1 () 
{ 
    meta="This function was generated for project: PROJECT1";
    echo "do my automation"
}

Ви можете використовувати вбудований nop: . Крім того, вам не потрібно зберігати його як змінну:

function f() {
  : your metadata here
  : "or here"
  # do yours
}

EDIT : Остерігайтеся спеціальних символів у ваших метаданих. Для чистого тексту можна використовувати:

: <<EOT
Your metadata text here.
EOT

EDIT : Ви можете використовувати замість глобального асоціативного масиву для зберігання метаданих усіх функцій:

declare -A METADATA=()
METADATA[fun1]='foo bar'
function fun1() {
  echo I have some metadata: "${METADATA[$FUNCNAME]}"
}
METADATA[fun2]='baz you'
function fun2() {
  echo I have some other metadata: "${METADATA[$FUNCNAME]}"
}

Таким чином, вам не потрібно розбирати declareабо typeвиводити вихід, а лише запитувати ключ масиву.

Ви можете це зробити.

$ f() { This function does nothing. 2> /dev/null; }
$ f
$ type f
f is a function
f () 
{ 
    This function does nothing. 2> /dev/null
}