用于车把助手的JSdoc文档

JSdoc doclet for handlebars helpers

本文关键字：JSdoc 文档 用于      更新时间：2023-09-26

我为正在构建的一个小型应用程序设置了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
 **/

此外，我希望确保手把助手在文档输出中有自己的独立部分。目前，所有内容都输出到全局部分。我应该使用@namespace还是@external来实现这一点？

提前感谢

您可以使用@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
 **/
相关文章：