Flash Builder文档自动添加类注释设定

我们在阅读别人或者flex sdk中的源码时，经常会发现诸如下面的注释： 

/** * @author XXXX

* @E-mail: [email protected] 

* @version 1.0.0

* 创建时间：2012-12-18 下午05:55:00

* */

这种符合ASDOC规范的注释，在flash builder 4里是可以悬浮提示。

对于如何生成注释，我知道有3种方法：

 1、直接按照ASDOC规范用键盘输入相关注释信息。这是最直接也是最无奈的方法。

 2、对于FB越来越人性化的设计我们应该是感到欣慰的。FB4提供了如eclipse中模板的设置，以便于我们在新建相关文档时自动生成注释。

 步骤：窗口->首选参数->flash builder->文本模板。在文本类型的窗口下面，提供了FB支持的所有文本的类型。这里我们只举个AS类文本模板的示例。

 a、展开ActionScript选项，选择ActionScript类。此时在下面的模板窗口里会显示你当前的AS类模板。默认是：这样是不能满足我们的要求的^_^。

 b、点击“文本类型”右面的编辑按钮，会弹出模板编辑框：我们可以在这里修改我们想要的文本模板。

将文本改成如下格式：

${package_declaration}
{
 ${import_declaration}
  /**
     * @author XXXX
     * @E-mail: [[email protected]][email protected][/email]
     * 创建时间：${date} ${time}
     *
     */
 ${class_declaration}
 {
  ${class_body}
 }
}

 这样我们新建一个AS类的时候就会自动生成如开头的注释了。

 对于有些使用系统变量的：${date} ${time}，可以通过编辑框下面的“插入变量（I）...”查找。 

3、快捷键快速添加注释（ctrl+shift+d）。将鼠标光标放在需要注释的函数体或者类体里，按下快捷键就可以了。

这种方法对于添加函数注释非常方便， 但是对于类注释好像内容不全（可能需要其他地方设置，希望知道的同学告知^_^）。

AS类文件的模板设置就这些了，其他类型的文件大家自己玩。

对于已经设置好的模板我们可以通过“文本类型”窗口右面的导出按钮导出模板（xml文件），用于团队共享。