jsdoc

2熱度

1回答

直列jsdoc我知道如何爲嵌入式類型參數： function foo(/**number*/theNum, /**string*/theText){} 但是我怎麼形容使用此方法的返回類型？我不是在談論這樣做上面的函數，這樣的方式： /** this method takes too much space! * @returns {boolean} */ function foo(){

2熱度

1回答

使用JSDoc如何註解一個descructured重命名的函數參數？

ES6語法允許重命名解構變量和參數。變量： const {requestID: _requestID, notifyChanges: _notifyChanges} = someObject; console.log(_requestID, _notifyChanges); 參數： /** * Creates a cloud ready request. * @param {Strin

4熱度

2回答

本地變量的正確JSDoc語法是什麼？

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

0熱度

1回答

我能在WebStorm基於JSDoc型檢查？

我想蘸我的腳趾在Javascript靜態類型的水，使用JSDoc註釋來強制類型安全（是的，我知道流量/打字稿，但他們沒有真正浸漬腳趾這麼多，因爲做一個大炮球入池中）。但是，我發現的唯一一種可以從我的JSDoc註釋中檢查我的代碼的工具是Google Closure編譯器，我沒有看到任何將它集成到Webstorm的方法（這樣我就可以，例如，當我給一個字符串賦值時，看到一條紅色的波浪線）。所以，我的

1熱度

2回答

如何正確評論部分應用的功能？

鑑於以下功能： const sameCharactersAs = a=> b => a.toLowerCase() === b.toLowerCase() 或 function sameCharactersAs(a){ return function(b){ return a.toLowerCase() === b.toLowerCase() } } 我怎

1熱度

1回答

在JSDoc註釋塊中是否允許製表符？

是否允許在JSDoc註釋塊中使用選項卡？ /** * Some description * * @function * @name someName * @summary And a summary */ 而不是... /** * Some description * * @function

4熱度

1回答

如何使用jsdoc爲流星應用

什麼是流星應用程序中使用JSDoc正確的方法是什麼？下面是我編寫代碼的方法，但所有部分之間沒有「連接」。所有內容都屬於示例模板，所以jsdoc的輸出結構應該正確。如何改善這個文件？ Template.example.helpers({ /** * Get all categories * @name categories * @return {Cu

0熱度

1回答

如何在JS文檔中記錄枚舉值

我正在使用JS文檔爲JS生成文檔。我有一個價值很少的枚舉。我想爲每個屬性生成文檔。我嘗試了以下內容： /** * Enum for display state. * @readonly * @enum {string} */ var DisplayState = { /** @member {string} */ foreground: 'foreground',

3熱度

1回答

JSDoc - 指定必需的參數語法

我正在使用@JSDoc爲我的JavaScript庫創建文檔。我知道如何表示可選參數。像下面一樣 /* * @param {string} [somebody] - Somebody's name. */ function sayHello(somebody) { if (!somebody) { somebody = 'John Doe'; } al

4熱度

2回答

在js上使用jsdoc和流類型註釋

當嘗試使用流類型註釋處理js源碼時，jsdoc解析器無法理解增強的語法！有沒有一種方法可以在js源代碼中使用jsdoc，這些jsdoc已經通過流類型註釋得到了增強，或者從類型帶註釋的js中生成文檔的推薦方法是什麼？