jsdoc3

0热度

1回答

我试图使用JSDoc 3.记录了AMD的JavaScript模块中的类下面是我的代码的基础上，例如文档here在： /** * A module representing a jacket. * @module my/jacket */ define('my/jacket', function() { /** * @class * @alias module:

2热度

1回答

AngularJS文档 - 它们是如何生成的？

AngularJS documentation清晰易读 - 它是如何生成的？如果使用JSDoc，样式表是否可用？

4热度

2回答

本地变量的正确JSDoc语法是什么？

对于这样的功能... function example() { var X = 100; ... var Y = 'abc'; ... return Z; } 我需要解释的一些局部变量的目的。添加像这样的描述... function example() { /** * @description - Need to

0热度

1回答

如何在JSDoc中记录深度大于2的符号？

我有一个包含多个方法的对象，并且是一个类的成员。我将如何用JSDoc记录这个？这是我的尝试。记录了这个SomeClass#helperFunctions，但是它的两个方法都被省略了。 /** * @class SomeClass * @param name */ var SomeClass = function(name) {}; /** * @memb

0热度

1回答

jsdoc如何破解/关闭一个标签

我想插入两个例子 /** *@method ChangeItem *@example *oMenu.ChangeItem("menu.enable_all",{enable:true}); *oMenu.ChangeItem("menu",label:"",icon:align:"after",text:ICO.arrow_down}}); * *If I write descript

0热度

1回答

如何在jsdoc-grunt任务中使用jsdoc选项

我想添加-p标志以生成使用grunt-jsdoc的私有方法的文档。我怎样才能做到这一点？根据grunt-jsdoc的文档，他们声明我们可以使用useJsDocCli中指定的任何选项，但不知道如何在grunt任务中指定它们。这是我目前的任务咕噜： jsdoc : { dist : { src: ['app/scripts/directives/*.js','READM

0热度

1回答

jsdocs3没有文档生成

这是我第一次使用jsdocs3，我无法生成我的文档。我创建了一个文件app.js并插入以下意见： - /** * Main file - All modules are loaded. * @author My Name * */ 然后我跑的命令./node_modules/jsdoc/jsdoc.js ./app/app.js -r -d文档/，结果如下图所示： - 我自己也尝试了

3热度

1回答

JSDoc - 指定必需的参数语法

我正在使用@JSDoc为我的JavaScript库创建文档。我知道如何表示可选参数。像下面一样 /* * @param {string} [somebody] - Somebody's name. */ function sayHello(somebody) { if (!somebody) { somebody = 'John Doe'; } al

0热度

1回答

JSDoc：如何将功能添加到导航栏

在jsdoc默认模板中，导航栏是在publish.jsbuildNav函数中构造的。例如 nav += buildMemberNav(members.events, 'Events', seen, linkto); 然而，没有members.functions。我想知道如何列出导航栏中的所有功能（在每个命名空间下的类）。

5热度

2回答

Javascript + JsDoc：如何记录新的ES6数据类型，如地图？

我想在我的ES6项目中使用JSDoc，我返回地图： /** * Some documentation.. * * @returns {undefined} <- This should be replaced */ function returningMap() { const someMap = new Map(); someMap.set("key", {a, b