JSDoc參考注釋模板


1. 注釋宏或者常量 

/**

 * Default Node tag
 * @constant
 * @type Number
 */
cc.CCNODE_TAG_INVALID = -1;

 

 

2. 注釋的分段采用<p>,<br/>,</P> 

 

3.注明類和繼承方式

/** 

 * @class

 * @extends cc.Class

 */

cc.Node = cc.Class.extend(/** @lends cc.Node# */{

});

 

 

4. 靜態構造函數的注釋

/** allocates and initializes a node.

 *

 * @constructs

 * @return {cc.Node}

 * @example

 * // example

 * var node = cc.Node.create();

 */

cc.Node.create = function () {

    return new this();

};

 

5. 函數方法的注釋方式:

    /** converts a CCTouch (world coordinates) into a local coordiante. This method is AR (Anchor Relative).

     *

     * @param {cc.Touch}touch

     * @return {cc.Point}

     */

    convertTouchToNodeSpaceAR:function (touch) {

        var point = touch.locationInView(touch.view());

        point = cc.Director.sharedDirector().convertToGL(point);

        return this.convertToNodeSpaceAR(point);

    },

其中數據類型有:Number, Boolean, Array,String,object,function,以及引擎的自定義類型,比如cc.Node,cc.Sprite等。

 

6. 名字空間

 /**

 * @namespace

 */

var cc = cc = cc || {}; 

 

 

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM