jsdoc3

    0热度

    1回答

    我想让我的JS文档正确。我使用的是Dojo,以及其他一些构建于其上的复杂框架,我会省略细节。关键是这个框架使用AMD模块。我想让我的JSDoc工作。 这是我到目前为止有: /** * Creates a button instance that launches a document entry template selector * @module widgets/instance/AddB

    3热度

    1回答

    我有一个字符串数组的数组,我不知道如何用JSDoc文件。 /** @class */ function PostbackList() { /** @type {int} @default */ this.TypeID = 0; /** @type {PostbackList.Field[]} */ th

    2热度

    1回答

    的Global菜单中缺少在导航的同时: 时不使用模板global.html文件存在 的Global条目存在于正确的TOC 是否有一个特殊的设置用于要求DocStrap Template将Global菜单添加到导航中? 以下是我的设置: Gruntfile.js jsdoc: { all: { src: [ './src/main/js/**/*.js',

    0热度

    1回答

    我想知道什么是文档参数(这是一个对象) 及其所有属性的正确方法。 如果我理解正确的话,方括号的意思是“可选”,对吗? 我用来描述对象属性的语法是否有效? reqSettings.retryInterval属性是一个数字,但我无法找到一种方法来包含它的单位。有没有办法表明这个数字是以毫秒为单位的? 代码: /** * used as a facade for the 'callServer

    2热度

    1回答

    我很努力地理解我当前的gulp文件中缺少的东西,以使JSDoc高兴。 下面的代码不会导致任何错误被抛出,但看着生成的文档的索引页,很明显我的文档没有被格式化。 缺少什么我在这里? 首先,这里是我想要记录的功能。 /** * Returns the sum of a and b * @param {Number} a * @param {Number} b * @return {Number

    -2热度

    1回答

    我已经从npm安装JSDoc和JSDoc 3工具。 npm install git+https://github.com/jsdoc3/jsdoc.git sudo apt-get install jsdoc-toolkit 成功安装的软件,执行的命令(jsdoc -r = DOC file.js)中,并生成具有文件的文件夹。 然而,加价将被忽略,index.html的链接仅仅在于以下路径,

    3热度

    2回答

    JSDoc有@readonly doclet tag: 的@ReadOnly标签指示符号旨在为只读。 例如: /** * The name of the represented principal * @member {string} * @readonly */ this.name = primaryName; 不过,我真正要沟通,文档是大众消费者应该治疗为只读属性 - 但该成员是

    6热度

    1回答

    我在理解联合中名称空间和模块的用途时遇到了一个问题。例如,我有一个类Game.utils.Matrix。我想注释Game为命名空间,utils作为一个模块和Matrix为一类: /** * @namespace Game */ /** * @module utils * @memberOf Game */ /** * Create a matrix * @constructo

    0热度

    2回答

    如何记录下面的代码片段?当我离开它,因为它是Foo.bar没有说明。当我添加@memberof标记时,它将记录为静态属性。添加@instance标签不会改变任何内容。这是相当简单和常见的代码模式,所以它应该很容易记录,对吗? 我讨厌jsdoc ... /** * @namespace */ var ns; (function (ns) { 'use strict';

    0热度

    1回答

    我想我是按照它在jsdoc3文档中解释的方式进行操作的。 我WebStorm是8.0.4 /** * This callback type is called `dbOpenCallback` and is displayed as a global symbol. * * @callback dbOpenCallback * @param {object} err * @param {