javascript - 用于 Handlebars 助手的 JSdoc doclet

Question

我为我正在构建的一个小型应用程序设置了 JSdoc。我最近也开始将 doclet 添加到我的 Handlebars 帮助程序文件中，但我在正确注释模式时遇到问题。

/**
 * My helper Name 
 * My helper description
 *
 * @method myHandlebarsHelper
 * @param options.hash.data {object} - some object
 * @param options.hash.param {string} - some string
 * @returns {string} some output string
 **/

此外，我想确保 Handlebars 助手在文档输出中拥有自己的独立部分。目前所有内容都输出到 Global 部分。我应该使用 @namespace 还是 @external 来完成此任务？

提前致谢

Answer 1

您可以使用@externals或另一种替代方法是记录一个(假)模块，即放置

/** @module handlebars */

在一个文件之上，并将所有帮助程序记录为该模块的成员。虽然语法上不正确，但可以很好地分开。

同样，您可以使用命名空间

/** @namespace HandlebarsHelper */

并将所有成员记录为

/**
 * My helper Name 
 * My helper description
 *
 * @method HandlebarsHelper.myHandlebarsHelper
 * @param options.hash.data {object} - some object
 * @param options.hash.param {string} - some string
 * @returns {string} some output string
 **/