相关疑难解决方法(0)

在旨在交互使用的函数中显示使用注释

我在 my 中定义了许多函数.bashrc,旨在在终端中交互使用。我通常在它们之前添加一条描述其预期用途的评论:

# Usage: foo [bar]
# Foo's a bar into a baz
foo() {
  ...
}
Run Code Online (Sandbox Code Playgroud)

如果浏览源代码,这很好,但是type在终端中运行以快速提醒该函数的作用是很好的。然而,这(可以理解)不包括评论:

$ type foo
foo is a function
foo ()
{
    ...
}
Run Code Online (Sandbox Code Playgroud)

这让我想到“如果这种评论持续存在以便type可以显示它们,那不是很好吗?” 本着 Python文档字符串的精神,我想出了这个:

foo() {
  : Usage: foo [bar]
  : "Foo's a bar into a baz"
  ...
}

$ type foo
foo is a function
foo ()
{
    : Usage: foo [bar];
    : "Foo's a bar into a baz";
    ...
} …
Run Code Online (Sandbox Code Playgroud)

bash function interactive

11
推荐指数
1
解决办法
836
查看次数

标签 统计

bash ×1

function ×1

interactive ×1