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 {