jsdoc3

0熱度

2回答

我試圖用JSDoc3記錄一些舊代碼，並且我試圖讓它在文檔中包含實例方法的參數 - 或者將任何東西顯示爲實例屬性。我懷疑問題在於代碼沒有遵循在javascript中僞造類的預期習慣用法，但我想在我開始重寫任何內容之前將所有內容都記錄下來。我試圖使問題的一個小例子，與實際代碼的結構： /** * Global function * @param {Object} v Stuff that they

1熱度

1回答

的IntelliJ說「未解決的變量或類型」，但它的使用@name

這部份代碼中定義： /** * @name Me * @property {String} name * @property {Number} minVer * @property {Number} maxVer */ /** @type {Me} the moshe*/ var y; 爲什麼說我的{}是沒有定義的IntelliJ？

0熱度

1回答

擴展jsDoc來處理自定義標籤

我期待擴展jsdoc（特別是docstrap）。我有一個nodeJS應用程序，並希望將jsdoc導航分割爲控制器，視圖等。我已經在一定程度上通過創建我的自定義標籤（如@controller），並設法讓它被類似於@module的JsDoc捕獲，因此它生成頁面（與描述）。然而，我的問題是，當涉及到與例如與'module.exports'功能位於控制器相關的功能。生成的文檔基本上忽略了@control

17熱度

1回答

jsdoc適當的方式來記錄socket.on（「事件」，函數（）{}）和路由處理器

如何使用它有以下形式（單個文件）jsdoc // api.js exports.addSocketEvents = function(socket) { /** * This will do that and ... * @param {Object} data Some data * @param {string} data.bla Something

4熱度

1回答

JSDOC：是否可以鏈接到模塊屬性？

我想知道是否有可能從一個模塊鏈接到另一個模塊的屬性/方法。我到目前爲止已經試過，但沒有工作： /** * {@link module:modules/modulName#id} */ 我模塊遵循這個模式： /** * @module modules/modulName */ define(function() { 'use strict'; /**

0熱度

2回答

JSDoc 3.3.3意外標記非法

在終端中，我運行以下命令： $ node sample.js hello, Stephen MC $ node_modules/.bin/jsdoc --version JSDoc 3.3.3 (Tue, 22 Sep 2015 23:14:17 GMT) $ node_modules/.bin/jsdoc -c jsdocConf.json Parsing /**/sample.js

4熱度

1回答

如何在JSDOC中記錄一個對象數組

我有一個以對象數組爲參數的函數，並且希望使用JSDOC來描述參數（包括數組中的對象的屬性），如下例所示： /** * @param {Array.<Object>} filter - array of filter objects * @param ... */ function doSomething(filter) { } ，其中過濾器是這樣的： filter = [

0熱度

1回答

Jsdoc命名空間與顯示模塊模式

我試圖讓命名空間與顯示模塊模式一起工作。我有看起來類似於以下代碼： /** * @namespace bigpage */ var bigpage = {}; /** * @namespace bigpage.data.methods * @memberOf bigpage.data */ bigpage.data.methods = bigpage.data.methods

1熱度

1回答

帶節點的jsdoc生成空的index.html

我使用以下命令從javascript文件生成html。 $> jsdoc --debug jquery.js $> open out/index.html 輸出命令 DEBUG: JSDoc 3.3.2 (Sat, 13 Jun 2015 22:20:28 GMT) DEBUG: Environment info: {"env":{"conf":{"tags":{"allowUnknown

1熱度

1回答

如何更改生成的JSDoc輸出的標題？

我試圖生成一個JavaScript文件的源代碼文檔。爲此，我還使用markdown語法編寫了自述文件。我運行： jsdoc -R client.md -d client client.js 該命令生成HTML文檔。在生成的輸出下面的標題定義： <title>JSDoc: Home</title> <h1 class="page-title">Home</h1> 我怎樣才能改變Home和J