简介
hubot-better-help 是一款为 Hubot 提供了更为灵活的帮助文档生成插件。通过该插件，我们可以使用自然语言的方式生成帮助文档，这样就可以更加方便地为机器人编写帮助文档。
安装
在使用 hubot-better-help 插件之前，我们需要先安装好 Node.js 和 Hubot 技术栈。接下来，我们可以使用 NPM 来安装 hubot-better-help 插件：
npm install --save hubot-better-help
当安装完成后，我们需要在我们的 Hubot 脚本中添加该插件，如下所示：
# external-scripts.json [ "hubot-better-help" ]
之后，我们就可以通过简单的命令来生成帮助文档了。
使用
hubot-better-help 的使用非常简单，只需要在 Hubot 脚本中使用如下代码：
module.exports = (robot) => {
robot.hear(/help/i, (res) => {
res.send(robot.helpCommands());
});
};这样，我们在聊天界面中输入 help，就可以得到一个包含所有已注册的命令的简单帮助文档。
如果我们想让帮助文档更加详细，我们可以在我们的 Hubot 脚本中加入更为详细的命令说明，例如：
-- -------------------- ---- -------
-------------- - ------- -- -
--------------------- ----- -- -
----------
---- ---- --------------- ----- - --- ---- ------
------- ---- ------ -------- - ---- ---- -- ----
----- ------- ------ --- ---- ------
---
---
--这样，我们就可以通过输入 help 命令，获得包含了所有已注册命令的详细帮助信息。在帮助信息中，我们会发现除了命令格式外还包含了命令的具体描述，这样可以帮助我们更好地理解每个命令的功能。
示例代码
为了更好地理解 hubot-better-help 插件的使用，在这里我们提供了一个示例代码：
-- -------------------- ---- -------
-------------- - --------------- -
------------------ ------- ----- -- -
----- ----------- - -
-- --- ---- --- ---- ----- ---------
---- ---- ---------------
------- ---- ------
----- ------
-------------
-----------------------
---
--------------------- ----- -- -
----------
---- ---- --------------- ----- - --- ---- ------
------- ---- ------ -------- - ---- ---- -- ----
----- ------- ------ --- ---- ------
---
---
------------------ ---- ------- ----- -- -
----- ----------- - -------------
---------------- ---- -------------------
---
--------------------- ---- ------- ----- -- -
----- -- - -------------
------------------ ---- ---- -- ----------
---
------------------- -------- ----- -- -
-------------------- --- ---- -- --------
---
--在这个示例中，我们创建了一个简单的 todolist 机器人。机器人支持添加、删除、列出所有任务的功能。当我们在聊天界面中输入 help 时，会获得一个包含了所有命令以及对应描述的帮助信息。
总结
通过使用 hubot-better-help 插件，我们可以为 Hubot 编写更为灵活、更为详细的帮助文档。这对于机器人的使用和扩展有着相当的帮助。希望读者在实践过程中能够更好地理解它的用法，从而为工作带来更大的便利。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055cb881e8991b448da409