jsdoc

    5熱度

    1回答

    我有一個JavaScript單爲: /** * A description here * @class */ com.mydomain.ClassName = (function(){ /** * @constructor * @lends com.mydomain.ClassName */ var ClassName = function(){}; /** * meth

    3熱度

    1回答

    我試圖使用jsdoc3來記錄我的模塊化主幹應用程序。不過,我收到錯誤,「異常來自未捕獲的JavaScript拋出:錯誤:缺少依賴:Backbone.model」當我試圖通過jsdoc運行這段代碼: /** * A module representing a dog model * @module dogModel */ define([ 'undersc

    13熱度

    2回答

    我不是個人生成文檔的大粉絲(我更像是一個「讀盧克源」的人),但我可以看到這種文件可能對其他人有用。現在,通常他們的文檔生成不會影響我,除了一件事情:@method。 大多數JSDoc註釋(如@param)仍然給別人閱讀源非常有用,但@method是100%的冗餘: /* * @param num number to add five to * @method addFive */ func

    5熱度

    3回答

    我有一個類通過Object.defineProperties定義了幾個實例屬性,我很難讓JSDoc 3認識到它們屬於它們的類。 這裏是我工作的一個簡化版本: /** @exports mymodule */ function mymodule(exports) { /** @constructor * @param {String} foo A foo. * @

    8熱度

    4回答

    我正在尋找一個可以在我的項目中使用的JSDoc解析器。我正在尋找一些可以傳遞JSDoc評論的東西,並接收關於評論含義的結構化描述。我所見過的大多數工具似乎都能夠將JSDoc註釋轉換爲HTML或其他格式。我正在尋找能夠提供評論的中間表示的東西,這些評論可以用來提供給其他工具。 有沒有我可以使用的任何工具或庫?

    0熱度

    1回答

    我使用webstorm ide和nodejs。當我創建模塊並需要它們時,我沒有代碼完成。 例如: test.js /** @module test*/ module.exports = { run: function() {} }; main.js var test = require(__dirname+"/test.js"); test. //code completion

    6熱度

    1回答

    我想記錄一個函數發生器,但沒有成功,這是一個例子: function genericObjectGenerator(tagname) { var specificObject = function() {}; specificObject.getClassName = function() { return tagname; } specifi

    0熱度

    1回答

    我的一個類生成jsDoc錯誤。我使用@extends來指定這個,但它仍然不起作用。文件使用閉包linter編譯沒有錯誤。 代碼可以在這裏找到」

    5熱度

    1回答

    我試圖記錄與JSDoc JavaScript文件(3)像這樣: /** 1 if gnome-bluetooth is available, 0 otherwise * @type {boolean} * @const */ const HA

    4熱度

    1回答

    我試圖找到如何讓JSDoc3自動生成到其他模塊的類的鏈接。 我覺得很難用文字解釋,所以讓我舉一些例子。下面的腳本生成預期的輸出: /** * @constructor */ var SomeClass = function(){} /** * @param {SomeClass} someParam description */ var someFunc = function(so