分配和检查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
}

编辑：当心特殊字符进入您的元数据。对于纯文本，可以使用：

: <<EOT
Your metadata text here.
EOT

编辑：您可以改用全局关联数组来存储所有函数的元数据：

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
}