我們在閱讀別人或者flex sdk中的源碼時,經常會發現諸如下面的注釋:
/** * @author XXXX
* @E-mail: XXX-XXX@163.com
* @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=XXX@XXX.net]XXX@XXX.net[/email]
* 創建時間:${date} ${time}
*
*/
${class_declaration}
{
${class_body}
}
}
這樣我們新建一個AS類的時候就會自動生成如開頭的注釋了。
對於有些使用系統變量的:${date} ${time},可以通過編輯框下面的“插入變量(I)...”查找。
3、快捷鍵快速添加注釋(ctrl+shift+d)。將鼠標光標放在需要注釋的函數體或者類體里,按下快捷鍵就可以了。
這種方法對於添加函數注釋非常方便, 但是對於類注釋好像內容不全(可能需要其他地方設置,希望知道的同學告知^_^)。
AS類文件的模板設置就這些了,其他類型的文件大家自己玩。
對於已經設置好的模板我們可以通過“文本類型”窗口右面的導出按鈕導出模板(xml文件),用於團隊共享。