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 documentation清晰易讀 - 它是如何生成的? 如果使用JSDoc,樣式表是否可用?

    4熱度

    2回答

    對於這樣的功能... function example() { var X = 100; ... var Y = 'abc'; ... return Z; } 我需要解釋的一些局部變量的目的。添加像這樣的描述... function example() { /** * @description - Need to

    0熱度

    1回答

    我有一個包含多個方法的對象,並且是一個類的成員。我將如何用JSDoc記錄這個? 這是我的嘗試。記錄了這個SomeClass#helperFunctions,但是它的兩個方法都被省略了。 /** * @class SomeClass * @param name */ var SomeClass = function(name) {}; /** * @memb

    0熱度

    1回答

    我想插入兩個例子 /** *@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回答

    我想添加-p標誌以生成使用grunt-jsdoc的私有方法的文檔。我怎樣才能做到這一點? 根據grunt-jsdoc的文檔,他們聲明我們可以使用useJsDocCli中指定的任何選項,但不知道如何在grunt任務中指定它們。這是我目前的任務咕嚕: jsdoc : { dist : { src: ['app/scripts/directives/*.js','READM

    0熱度

    1回答

    這是我第一次使用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爲我的JavaScript庫創建文檔。我知道如何表示可選參數。像下面一樣 /* * @param {string} [somebody] - Somebody's name. */ function sayHello(somebody) { if (!somebody) { somebody = 'John Doe'; } al

    0熱度

    1回答

    在jsdoc默認模板中,導航欄是在publish.jsbuildNav函數中構造的。 例如 nav += buildMemberNav(members.events, 'Events', seen, linkto); 然而,沒有members.functions。 我想知道如何列出導航欄中的所有功能(在每個命名空間下的類)。

    5熱度

    2回答

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