简介
hubot-even-better-help 是一个提供命令行帮助的 Hubot 插件，它可以在帮助文档中添加段落、标签和模块的帮助内容，使得帮助文档更加详尽完整。
安装
要安装 hubot-even-better-help 插件，只需在命令行中输入以下命令：
npm install --save hubot-even-better-help
配置
要使用 hubot-even-better-help 插件，需要在 external-scripts.json 文件中添加 hubot-even-better-help 注册项。如下所示：
["hubot-even-better-help"]
使用
使用 hubot-even-better-help 插件是非常容易的。只需在命令行中输入 hubot help 命令，就会列出所有的可用命令及其相关的说明文档。
hubot-even-better-help 支持以下的命令格式：
hubot command -h # 显示命令的简介帮助信息 hubot command --help # 显示命令的完整帮助信息 hubot help command # 显示命令的完整帮助信息
示例
下面是一个使用示例，假设我们有一个叫做 greet.coffee 的 Hubot 脚本，这个脚本可以向用户打招呼。我们可以把一些简介和详细的说明文档添加到帮助文档中，如下所示：
-- -------------------- ---- -------
- ------------
- - ----- ------
-
- -------------
- ----
-
- --------------
- ----
-
- ---------
- ----- ----- - ------
-
- ------
- ----
-
- -------
- ---- ---
-------------- - ------- --
------------- --------- ----- --
--------- ------- --- --- -----在这个脚本中，我们使用了 Description、Dependencies、Configuration、Commands 和 Notes 等标签，这些标签将帮助信息分成几个小节，并为每个小节提供了简短的摘要。
当我们在命令行中输入 hubot help 命令时，将会显示出如下的帮助文档：
[文档摘要] [命令] hubot hello - 向用户打招呼 [使用说明] None
当我们在命令行中输入 hubot help hello 命令时，将会显示出如下的帮助文档：
命令：hubot hello 向用户打招呼 用法：hubot hello [使用说明] None
总结
本文介绍了如何使用 npm 包 hubot-even-better-help，它可以帮助我们创建详尽完整的帮助文档，使得我们的 Hubot 脚本更加易于使用和维护。希望本文能对你有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005664481e8991b448e2574