jsdoc3

0热度

2回答

我试图用JSDoc3记录一些旧代码，并且我试图让它在文档中包含实例方法的参数 - 或者将任何东西显示为实例属性。我怀疑问题在于代码没有遵循在javascript中伪造类的预期习惯用法，但我想在我开始重写任何内容之前将所有内容都记录下来。我试图使问题的一个小例子，与实际代码的结构： /** * Global function * @param {Object} v Stuff that they

1热度

1回答

的IntelliJ说“未解决的变量或类型”，但它的使用@name

这部份代码中定义： /** * @name Me * @property {String} name * @property {Number} minVer * @property {Number} maxVer */ /** @type {Me} the moshe*/ var y; 为什么说我的{}是没有定义的IntelliJ？

0热度

1回答

扩展jsDoc来处理自定义标签

我期待扩展jsdoc（特别是docstrap）。我有一个nodeJS应用程序，并希望将jsdoc导航分割为控制器，视图等。我已经在一定程度上通过创建我的自定义标签（如@controller），并设法让它被类似于@module的JsDoc捕获，因此它生成页面（与描述）。然而，我的问题是，当涉及到与例如与'module.exports'功能位于控制器相关的功能。生成的文档基本上忽略了@control

17热度

1回答

jsdoc适当的方式来记录socket.on（“事件”，函数（）{}）和路由处理器

如何使用它有以下形式（单个文件）jsdoc // api.js exports.addSocketEvents = function(socket) { /** * This will do that and ... * @param {Object} data Some data * @param {string} data.bla Something

4热度

1回答

JSDOC：是否可以链接到模块属性？

我想知道是否有可能从一个模块链接到另一个模块的属性/方法。我到目前为止已经试过，但没有工作： /** * {@link module:modules/modulName#id} */ 我模块遵循这个模式： /** * @module modules/modulName */ define(function() { 'use strict'; /**

0热度

2回答

JSDoc 3.3.3意外标记非法

在终端中，我运行以下命令： $ node sample.js hello, Stephen MC $ node_modules/.bin/jsdoc --version JSDoc 3.3.3 (Tue, 22 Sep 2015 23:14:17 GMT) $ node_modules/.bin/jsdoc -c jsdocConf.json Parsing /**/sample.js

4热度

1回答

如何在JSDOC中记录一个对象数组

我有一个以对象数组为参数的函数，并且希望使用JSDOC来描述参数（包括数组中的对象的属性），如下例所示： /** * @param {Array.<Object>} filter - array of filter objects * @param ... */ function doSomething(filter) { } ，其中过滤器是这样的： filter = [

0热度

1回答

Jsdoc命名空间与显示模块模式

我试图让命名空间与显示模块模式一起工作。我有看起来类似于以下代码： /** * @namespace bigpage */ var bigpage = {}; /** * @namespace bigpage.data.methods * @memberOf bigpage.data */ bigpage.data.methods = bigpage.data.methods

1热度

1回答

带节点的jsdoc生成空的index.html

我使用以下命令从javascript文件生成html。 $> jsdoc --debug jquery.js $> open out/index.html 输出命令 DEBUG: JSDoc 3.3.2 (Sat, 13 Jun 2015 22:20:28 GMT) DEBUG: Environment info: {"env":{"conf":{"tags":{"allowUnknown

1热度

1回答

如何更改生成的JSDoc输出的标题？

我试图生成一个JavaScript文件的源代码文档。为此，我还使用markdown语法编写了自述文件。我运行： jsdoc -R client.md -d client client.js 该命令生成HTML文档。在生成的输出下面的标题定义： <title>JSDoc: Home</title> <h1 class="page-title">Home</h1> 我怎样才能改变Home和J