jsdoc

0熱度

1回答

我在代碼中有幾次的基本模式是exports.thing = thingFromSomewhereElse，我想記錄thingFromSomewhereElse的函數成員，就像我自己定義它們一樣。但我不明白如果沒有實際的thing.functionName = function() {...}這樣做怎麼辦。如果我嘗試使用@callback標記，JSDoc會將它歸類爲類型定義而不是成員。有沒有辦法讓它

1熱度

1回答

流星jsdoc不被識別爲一個內部或外部命令，可操作的程序或批處理文件

我想按照這裏的步驟設置流星jsdoc在現有流星項目： https://www.npmjs.com/package/meteor-jsdoc 我使用windows和我運行> npm install -g meteor-jsdoc，它是成功的但是，當我嘗試運行> meteor-jsdoc時，它會給出錯誤，如標題中所示。我試着在文件夾內外運行npm install。任何人都有過之前的經驗？我真的被

16熱度

1回答

JSDoc typedef在單獨的文件中

我可以在單獨的文件中定義所有自定義類型（例如types.jsdoc），以便它們可以在整個應用程序中重用？什麼是正確的做法？ /** * 2d coordinates. * @typedef {Object} Coordinates * @property {Number} x - Coordinate x. * @property {Number} y - Coordinate y. *

0熱度

1回答

JSDoc - 如何分配功能作爲另一個功能

給出下面，當我運行jsdoc，輸出不顯示爲foo.bar任何財產的屬性。 /** * Foo */ const foo = function foo() { //... } /** * Bar */ foo.bar = function bar() { //... } 如何顯示bar爲上foo的屬性？

0熱度

2回答

如何解決此ESLint/JSDoc語法錯誤？

我已經證明這個功能... /** * Perform an asynchronous HTTP (Ajax) request. * * @param {String|Object} url A string containing the URL to which the request is sent, or the settings object. * @param {Object=}

0熱度

1回答

jsdoc使所有下劃線方法私有

我有一個使用jsdoc的大型代碼庫。我們只注意到很多私有方法沒有@private標誌。有沒有一種方法來設置配置地看到，下劃線作爲私有開始的所有方法？我真的很想避免不得不通過數百個文件手動完成。

0熱度

1回答

JSDoc可以鏈接到源代碼行嗎？

有沒有辦法讓jsdoc直接鏈接到源代碼文件中的行而不是僅僅到文件的開頭？

2熱度

1回答

如何在jsdoc中使用@param

我知道這是一個愚蠢的問題，但我剛開始使用jsdoc，並且遇到了試圖生成doc文件的問題。我跟蹤了一些我在網上發現的例子，這些例子看起來基本相同，但由於某些原因，我無法生成我想要記錄的變量之一的文檔。這是我的代碼。 /** *@fileOverview mainController ' main controller file' *@param Controller here */ fu

0熱度

1回答

如何使用jsdoc對ES6類@mixes結合WebStorm

使用的對象JSDoc的@mixin，我可以寫這樣的事： /** * @mixin foo */ const foo = { myMethod() {} } /** * @mixes foo */ const bar = { } 和我WebStorm IDE顯示bar有myMethod方法。我喜歡用從核心裝飾的@mixin裝飾在我班上一些對象混合： /* * @

2熱度

3回答

如何使用打字稿jsdoc註解陣營PropTypes

定義時使用的反應打字稿組件，我們可以寫類似： class SomeComponent extends React.Component<PropInterface, StateInterface> { // ... } 有沒有辦法做相當於使用jsdoc annotations，並有道具類型檢查。