jsdoc

1熱度

1回答

我正在尋找在我的文檔中有JSON示例，而我的文檔中將會有我的智能感知VScode中的JSON示例。我已經試過本書中的每一個技巧，我可以想到，這是可能做的換行符和使JSON可讀的東西嗎？無論我做什麼，我都無法在VScode中使用它，它會佔用空白區域並製作一行。我嘗試這樣做： /** * { * "JSONData":"not going to format like this" * }

1熱度

1回答

VS代碼中的jsDoc @callback

VS代碼中有沒有某種方法可以使用jsDoc的@callback標籤？我試圖從jsDoc documentation of the callback tag剪斷下面的代碼： /** * @class */ function Requester() {} /** * Send a request. * @param {requestCallback} cb - The callback

0熱度

1回答

如何使用Visual Studio Code的Intellisense查看函數的文檔？

我正在用Mac上的Visual Studio Code編寫Javascript。我有這個功能，在JSDoc格式記錄： /** * Adds the passed Matter Body to the simulation. * @param {Matter.Body} body - The body to add to the physics simulation * @param {st

1熱度

1回答

手動JSDoc註釋 - 創建模板

我被要求爲我們的開發人員創建一個JSDoc模板來記錄他們的ES6代碼。我不確定哪個70 or so @ block tags會有用，以及我是否會讓開發人員陷入過多的文檔要求。 documentation給出了非常簡單的例子，這實際上沒有幫助。尋找對經驗豐富的JavaScript開發人員最有用的一組塊標籤的真實世界體驗。當我問我們的時候，他們只會說：「無論你決定！」，但稱他們爲有經驗的JavaSc

2熱度

1回答

如何在JSDoc中正確定義自己的類的類型？

我有一個簡單的ES6類，我想知道如何在JSDoc中正確地描述它。請注意，我想定義我自己的類型，稍後將由WebStorm自動完成識別。下面的示例有效嗎？ /** * @typedef {Object} View * @class */ class View{...}

0熱度

1回答

有申報通過JSDoc語法類型參數中的javascript打字稿瞭解

這個文件的方式： https://github.com/Microsoft/TypeScript/wiki/JSDoc-support-in-JavaScript 沒有提及類型參數問題：是通過JSDoc類型註釋支持的類型參數S' 如果是這樣，我該怎麼做？

-1熱度

1回答

在Angular項目上運行的JavaScript JSDoc

我正在使用Angular CLI構建的Angular 4項目。接下來，我想安裝JSDOC 我這樣做如下說明： - npm install -g jsdoc - npm install --save-dev jsdoc 所以，現在我把它安裝。我的問題是......我下一步要做什麼來生成doc文件？它說，在文檔中運行此命令： jsdoc yourJavaScriptFile.js 是什麼意

1熱度

2回答

jsdoc和vscode：記錄一個函數作爲參數傳遞給另一個函數

我試圖在javascript中記錄輸入參數到一個函數，但我無法解決如何在jsdoc中執行它。我看了一下jsdoc文檔，它建議使用@callback評論是必需的，但Visual Studio代碼（vscode）不會按照屏幕截圖來突出顯示它。用於location參數的智能感知表明，它的類型any而非locator類型（具有id一個參數，它返回一個Location的函數）的。示例代碼顯示了一個函數

0熱度

1回答

Tern無法使用JSDoc類型信息

我試圖使用Tern對某些Javascript代碼執行類型推斷。但是，類型推斷似乎並沒有在代碼中使用JSDoc註釋。我使用代碼/** @type {Foo} */ let x;作爲問題的示例。在Tern website's demo page（使用CodeMirror）上，編輯器能夠推斷出x的類型爲Foo。然而，當通過節點本地運行時，我得到了這個：{ type: '?', exprName: '

2熱度

1回答

引用node.js中的* documentation * @return語句

我們這裏所說的全部是關於代碼記錄。要有兩個功能，f1和f2： /** * @return {Boolean} always true */ const f1 =() => true; /** * @return {Boolean} always true */ const f2 =() => { console.log('friendly wrapper of f1(