☰

功能选项帮助

tag-icon • tag-icon bash manpage functions
功能选项帮助

我正在为正在编写的 bash 函数编写文档。它支持颜色选项，可以是以下之一--vlt --blu --grn --ylw --orn --pur --red --wht。我使用了以下描述，但不确定它是否足够容易理解，并希望改进此描述性帮助。

 --COLR
   Colour Option
 
   --COLR  Brief   |  --COLR  Brief
   ----------------+----------------
   --vlt   Violet  |  --orn   Orange
   --blu   Blue    |  --pur   Purple
   --grn   Green   |  --red   Red
   --ylw   Yellow  |  --wht   White

答案1

如果将含糊不清的单词“简要”替换为更具描述性的短语“颜色名称”，bash 函数文档将更容易理解。如果是通过命令从终端调用的手册man，您还可以通过将第一行格式化为粗体文本（手册页中经常这样做）来提高可读性。

--颜色
  颜色选项

  --COLR 颜色名称 | --COLR 颜色名称
  --------------------+--------------------
  --vlt 紫色 | --orn 橙色
  --blu 蓝色 | --pur 紫色
  --grn 绿色 | --red 红色
  --ylw 黄色 | --wht 白色

相关内容