用帮助提示扩展yang以提示cli

Question

我正在编写一个新的CLI，我正在考虑使用yang作为数据定义语言。它几乎拥有我所需要的一切:强制/选项、类型、派生类型、可接受的范围、描述和大量现有模块。

但是，我想提供简短的帮助提示:输入“？”并通过一个简短的帮助来查看下一个字段的可能值(例如，最多60个字符)。据我所知，.yang结构中没有简短的提示。

如何向.yang文件中添加简短的提示信息？是否有一个只包含简短提示的配套文件？扩展.yang格式？将这些信息嵌入到.yang注释中？

我肯定我不是第一个这么做的人，推荐的做法是什么？我怀疑答案是“伙伴文件”，因为它将与现有的.yang文件一起工作。

Answer 1

description语句用于为模块读取器提供信息。如果您想提供更方便用户的文本，您可以定义自己的语句。为此目的，杨支持extension声明。

定义它：

module my-extensions {
       ...

   extension help {
       description "Takes as argument a help-text string.";
       argument "text";
   }
}

使用它：

module example {
   import my-extensions {
       prefix "myext";
   }
       
   container example {
       myext:help "This is an example container";
   }
}

Answer 2

最后，我使用了description字段作为帮助字符串源。