gán và kiểm tra siêu dữ liệu hàm bash

Tôi thường tạo và đăng ký rất nhiều hàm bash tự động hóa nhiều nhiệm vụ tôi thường làm trong các dự án phát triển của mình. Thế hệ đó phụ thuộc vào siêu dữ liệu của dự án tôi đang làm.

Tôi muốn chú thích các chức năng với thông tin của dự án mà chúng được tạo, theo cách này:

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

Lý tưởng nhất, tôi sẽ có thể thấy bình luận khi tôi kiểm tra định nghĩa:

$ type func1

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

Nhưng bằng cách nào đó bash dường như bỏ qua các bình luận tại thời điểm tải chức năng, không phải khi thực hiện nó. Vì vậy, các ý kiến ​​bị mất và tôi nhận được kết quả này:

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

Có cách nào để gán siêu dữ liệu cho các hàm và kiểm tra chúng sau đó không? Có thể lấy nó khi kiểm tra định nghĩa với loại?

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
}

Có, typedường như chỉ in ra các phần của một chức năng sẽ được chạy. Điều này có vẻ hợp lý với tôi, thực sự, vì thường đó là tất cả những gì bạn quan tâm khi truy vấn type.

Để khắc phục, thay vì sử dụng nhận xét, hãy thêm dữ liệu meta của bạn như thế này:

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

Không cần thực sự sử dụng biến đó, nhưng nó sẽ xuất hiện khi truy vấn hàm với type:

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

Bạn có thể sử dụng nội dung nop: . Ngoài ra, bạn không cần lưu trữ dưới dạng một biến:

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

EDIT : Coi chừng các ký tự đặc biệt vào siêu dữ liệu của bạn. Đối với văn bản thuần túy, bạn có thể sử dụng:

: <<EOT
Your metadata text here.
EOT

EDIT : Thay vào đó, bạn có thể sử dụng một mảng kết hợp toàn cầu để lưu trữ siêu dữ liệu của chức năng:

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

Theo cách này, bạn không cần phân tích cú pháp declarehoặc typeđầu ra, mà chỉ truy vấn khóa của một mảng.

Bạn có thể làm được việc này.

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