Question

我已经为我正在构建的小应用程序设置了JSdoc。我最近开始将doclet添加到我的把手助手文件中，但是我无法正确地注释模式。

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

另外，我想确保把手助手在doc输出中有自己的自包含部分。目前，所有内容都输出到全局部分。我应该使用@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

1 个答案: