jsdoc

    4热度

    1回答

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

    2热度

    2回答

    我想知道jsdoc中角度指定的东西上的“正确”参数类型是什么? 例如,如果我有这样的: /** * Some comment * * @param {WhatHere} $http * @param {WhatHere} $timeout */ function FooBar($http, $timeout) { } 什么是正确类型的$ http和$超时使IDE(网络/ PhpS

    0热度

    1回答

    我jsDocs自动完成这个: /** * @returns {Array.<T>} */ 什么是.<T>意味着在这一背景下,有一组也可以是其他值?

    13热度

    1回答

    所有的官方JSDoc例子有天真简单的文档字符串,如下所示: /** * @param {string} author - The author of the book. */ 的问题是,在现实生活中的文档中,你往往有较长的文档字符串: /** * @param {string} author - The author of the book, presumably some person

    4热度

    1回答

    我一直很难获得在JSDoc中工作的@borrows标签。我一直在尝试从一个函数获取文档,并将它作为第二个函数的文档。但我似乎甚至无法得到一个简单的例子! /** * This is the description for funcA */ var funcA = function() {}; /** * @borrows funcA as funcB */ var funcB =

    4热度

    2回答

    我试图让JSDOC(3)正确记录我的NodeJS模块。虽然简单的模块工作,但我找不到方法来记录一个稍微复杂的模块。 我的NodeJS模块具有以下结构: /** @module MyModule */ (function() { function functionToExportOne {...} function functionToExportTwo {...}

    0热度

    2回答

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

    1热度

    1回答

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

    3热度

    1回答

    我需要为JSDoc中的教程添加静态资源。我的项目 结构是: PROJECT ROOT | | ---> Project directory A ---> Project directory B ---> ... | ---> Tutorials | | | -------->IMG 目录教程/ IMG包含我想包括静态资源。 我CONF文件是

    2热度

    1回答

    jsDoc似乎支持大多数MD语法,但是当突出显示单个保留字或文本时,我找不到可用的标记。 在MD语法中,我可以使用`word`,它会设置一个灰色背景和一个不同的字体,所以您可以清楚地看到它,就像在StackOverflow上一样 - word。 在jsDoc,我是否使用`word`或<码字> < /代码>,其效果也只是设置斜体样式到字,不能清楚地看到作为一个保留字。 jsDoc中是否有任何语法清楚