bash işlevi meta verilerini atama ve inceleme

Geliştirme projelerimde genellikle yaptığım görevlerin çoğunu otomatikleştiren birçok bash işlevi oluşturup kaydediyorum. Bu nesil üzerinde çalıştığım projenin meta verilerine bağlı.

Bu şekilde oluşturuldukları proje bilgileri ile işlevlere açıklama eklemek istiyorum:

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

İdeal olarak, tanımı incelerken yorumu görebileceğim:

$ type func1

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

Ancak bash, bir şekilde , işlevi yüklerken değil, yorumları yüklerken yorumları görmezden geliyor gibi görünüyor. Böylece yorumlar kaybolur ve bu sonucu alırım:

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

İşlevlere meta veri atamanın ve daha sonra bunları kontrol etmenin herhangi bir yolu var mı? Tanımı tür ile incelerken geri almak mümkün mü?

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
}

Evet, typebir işlevin yalnızca çalıştırılacak kısımlarını yazdırıyor gibi görünüyor. Bu benim için makul görünüyor, çünkü sorgulama yaparken genellikle ilgilendiğiniz bu kadar type.

Çözüm olarak, yorumları kullanmak yerine meta verilerinizi şu şekilde ekleyin:

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

Bu değişkeni gerçekten kullanmaya gerek yoktur, ancak işlev şu şekilde sorgulanırken görünür type:

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

Nop yerleşimini kullanabilirsiniz :. Ayrıca, bir değişken olarak saklamanız gerekmez:

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

EDIT : Meta verilerinize özel karakterlere dikkat edin. Saf metin için şunları kullanabilirsiniz:

: <<EOT
Your metadata text here.
EOT

DÜZENLEME : Bunun yerine tüm işlevin meta verilerini depolamak için genel ilişkilendirilebilir bir dizi kullanabilirsiniz:

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]}"
}

Bu şekilde, ayrıştırmak gerekmez declareveya typebir dizinin anahtarı için sadece sorgu ancak, 'ın çıkışı.

Bunu yapabilirsiniz.

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