车把帮手的JSdoc doclet

我有一个JSdoc设置了我正在构建的一个小应用程序。我最近开始将doclet添加到我的handlebar帮助程序文件中，但我在正确注释模式时遇到了麻烦。车把帮手的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 
**/

另外，我想确保handlebars助手在doc输出中有自己的自包含部分。目前所有内容都输出到全局部分。我应该使用@namespace还是@external来完成此操作？

在此先感谢

来源

2015-04-03 am80l

这取决于你想如何构建你的项目。您可以将所有助手放在自己的部分中。或者将不同的助手与他们相关的其他代码分组。 – 2015-04-03 20:34:42

我想我的问题是我不知道如何为少数的.js文件创建一个独特的部分。我对jsDoc非常陌生，所以它可能我正在考虑这个错误：/ – am80l 2015-04-03 23:52:38

你可以使用@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 
**/

来源

2015-04-08 11:45:59 SGD

车把帮手的JSdoc doclet

回答

相关问题