JavaScript项目优化总结(1)(6)

YUIDoc标签

要使用YUIDoc，那么所有注释都得安装YUIDoc的标准来，否则不能正确解析出文档。YUIDoc使用的标签和其它语言类同，比较容易理解。下面不详细说明每个标签，只列举几个例子，具体可参加官方文档。例如：

对PetConfigParser类进行注释：

/**  
 * 宝宝配置文件解析，及提供查询宝宝配置相关的操作方法<br/>  
 * 1. getPetById 根据宝宝id获取对应宝宝的信息<br/>  
 * 2. getPetName 根据宝宝的id，读取宝宝信息，然后拼接出宝宝的名字，如3+10天蝎宝宝<br/>  
 * 等等<br/>  
 * @author tylerzhu  
 * @class PetConfigParser  
 * @static  
 */ 

对类中的变量进行注释：

/**  
    * 宝宝所有配置字典，以【cate * 10000 + (lvl - 1) * 10 + dex - 1】为key  
    * @attribute    petDic  
    * @type {Object}  
    * @private  
    */ 

对类中函数进行注释：

/**  
     * 根据宝宝id，读取__pet_config中对应宝宝的信息  
     * @method getPetById  
     * @param   {String/int} petId 宝宝id  
     * @return  {Object} pet 宝宝的所有静态信息，如{id:"300003289", lvl:"1", dex:"2", price:"200", life:"2592000", cate:"3", name:"飞天小使等级1熟练2", intro:"", skill:"护身符", skill1_prob:"30", skill2_prob:"0"}  
     */ 

默认生成的文档样式如下：

参考链接、进一步阅读

[1]NodeJS，http://nodejs.org/

[2]UglifyJS，https://github.com/mishoo/UglifyJS/

[3]用UglifyJS解析/压缩/格式化你的Javascript，http://goo.gl/bwf8U

[4]Yahoo前端优化性能规则，http://goo.gl/nfEBg

[5]用YUIDoc文档化JavaScript代码，http://goo.gl/5RJxn

[6]YUIDoc官方，http://yui.github.com/yuidoc/