车把助手的 JSdoc doclet

Question

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

/**
 * 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
 **/

此外，我想确保车把助手在文档输出中有自己的独立部分。目前一切都输出到全局部分。我应该使用@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
 **/

车把助手的 JSdoc doclet

JSdoc doclet for handlebars helpers

javascript

jsdoc

handlebars.js

handlebarshelper