在没有使用ASDoc之前, 我的注释总是乱七八糟, 并且胡说八道. 该讲的没有讲清楚, 废话比代码还多. 自从抱着试试看的态度用了一下ASDoc, 俺决定认真参照公司的代码规范, 认真规范下俺不曾被规范的注释.
ActionScript注释生成工具很多, 但俺们唯独使用ASDoc.
首先, 总结下ActionScript注释规范:
我该牢记的, 各参数出场顺序: @param @return @throws @see 如:
/**
* 解析给定的I18N语言字符串, 并通过fieldStringToLocalizationItem将之转换为LocalizationItem对象,放入到ArrayCollection中.
* @example 处理里一串I18N语言字符串
*
* stringToAC(‘{zh=简体中文}{zh_tw="繁体中文"}’, false);
*
* @param s:String 待处理的字符串
* @param strict:Boolean 是否采用严格机制来处理, [...]
需求: 透过工程注释自动化产生文档
分析:使用ANT进行自动化配置, 使用ASDoc产生注释
在所在工程中新建一个properties文件,用以保存相关配置, 同时建立一个bulid.xml, 用以提供ANT配置文件.
具体实现:
1: 为便于管理与配置, 将ASDoc的参数放置于一个properties文件中, 在本例中我们取名叫做: asdoc.properties 含如下信息: FLEX_HOME = E:\\eclipse-jee-europa-fall2-win32_FB3\\eclipse\\FBPlug-in301\\sdks\\3.1.0 asdoc.exe = E:\\eclipse-jee-europa-fall2-win32_FB3\\eclipse\\FBPlug-in301\\sdks\\3.1.0\\bin\\asdoc.exe dir.docSource = com\\insprise\\localizationeditor dir.src = . dir.output = E:\\eclipse-jee-europa-fall2-win32_FB3\\eclipse\\workspace\\AIRTest\\doc main.title = Test [...]
最新的三6条正面评论