0

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

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

如何将简短的提示信息添加到 .yang 文件中？有一个只包含简短提示的配套文件吗？扩展 .yang 格式？将此信息嵌入 .yang 评论中？

我确定我不是第一个这样做的人，推荐的做法是什么？我怀疑答案是“伴随文件”，因为它可以与现有的 .yang 文件一起使用。

4

2 回答 2

1

该description语句用于为模块阅读器提供信息。如果您想提供更加用户友好的文本，您可以定义自己的语句。YANG 支持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";
   }
}
于 2021-01-19T22:56:25.967 回答
0

我最终使用描述字段作为帮助字符串源。

于 2021-01-10T14:00:57.530 回答