如何記錄與JSDoc3

AMD +骨幹項目，我有一個Backbone boilerplate基礎的項目，我想最近jdoc-toolkit 如何記錄與JSDoc3

記錄雖然我不能讓它產生任何東西，但空_global類

代碼示例：

/** 
* This is a root model for DLClass 
* @module models/DLClass 
*/ 
define([ 
    'underscore', 
    'backbone' 
], /** @lends DLClass */ function (_, Backbone) {   
    /** 
    * This is a root model for DLClass 
    * @class DLClass 
    * @constructor 
    * @return Session Object 
    */ 
    var DLModel = Backbone.Model.extend({ 
     /** @lends DLClass.prototype */ 

    /** 
    * Generic tap event 
    * @param touchEvent 
    */ 
    onTap: function (touchEvent) { 

    },

來源

2013-03-01 Max The Cat

你可能不認爲這是一個非常有益的建議，但你可能要考慮，你可能獲得全部或幾乎全部的通過僅僅使用JSDoc你已經是這樣，從來沒有產生文檔文件預期的效益。您的開發人員應該完全能夠閱讀.js文件中的文檔，而不需要生成HTML，並且通過這樣做，您完全可以避免此問題中的問題。 – machineghost 2013-04-26 05:06:57

嘗試添加@namespace讓JSDoc知道查看模塊的內容。並使用@name定義您的模塊和它的功能。

/** 
* This is a root model for DLClass 
* @module models/DLClass 
* @namespace 
*/ 
define([ 
    'underscore', 
    'backbone' 
], /** @lends DLClass */ function (_, Backbone) {   
    /** 
    * This is a root model for DLClass 
    * @class DLClass 
    * @module models/DLClass 
    * @name DLClass 
    * @constructor 
    * @return Session Object 
    */ 
    var DLModel = Backbone.Model.extend({ 
     /** @lends DLClass.prototype */ 

     /** 
     * Generic tap event 
     * @name DLClass.onTap 
     * @function 
     * @param touchEvent 
     */ 
     onTap: function (touchEvent) { 

     },

來源

2013-05-10 18:28:43 sweetamylase

如何記錄與JSDoc3

回答

相關問題