linux - 如何在 bash 中评论参数列表

Question

如何注释函数的参数列表？我想做这样的事情，这是行不通的:

my_func \
  # This is for something
  arg_1 \
  \
  # This is for something else
  arg_2 \
  \
  # This is not not for anything
  arg_3

这显然行不通。有什么办法可以实现这样的目标吗？下一个选项是这样的:

my_func \
  arg_1 \ # This is for something
  arg_2 \ # This is for something else
  arg_3 # This is not not for anything

这在我的书中不太受欢迎，但也行不通。有什么想法吗？

Answer 1

使用命令替换作为虚假注释既昂贵(您仍然必须 fork 一个 shell 并解析注释)又可能很危险(命令替换可以嵌套，但仍会执行)。更好的方法是将参数存储在一个数组中，这样就不会无意中执行。

args=(
      # This is for something
      arg_1

      # This is for something else
      arg_2

      # This is not not for anything
      arg_3
)

my_func "${args[@]}"

如果您需要保持 POSIX 兼容，这意味着没有数组，我建议在调用之前简单地记录参数:

# Arg 1: this is for something
# Arg 2: this is for something else
# Arg 3: this is not for anything
my_func \
  arg_1 \
  arg_2 \
  arg_3