我們?cè)陂喿x別人或者flex sdk中的源碼時(shí),經(jīng)常會(huì)發(fā)現(xiàn)諸如下面的注釋:
/**
* @author moge
* @E-mail: mochb-5718@163.com
* @version 1.0.0
* 創(chuàng)建時(shí)間:2010-10-18 下午01:28:23
*
*/ 這種符合ASDOC規(guī)范的注釋,在flash builder 4里是可以懸浮提示的(可以參看《flash builder4入門教程》3.2和4.7兩節(jié)內(nèi)容)。
對(duì)于如何生成注釋,我知道有3種方法:
1、直接按照ASDOC規(guī)范用鍵盤輸入相關(guān)注釋信息。這是最直接也是最無奈的方法。
2、對(duì)于FB越來越人性化的設(shè)計(jì)我們應(yīng)該是感到欣慰的。FB4提供了如eclipse中模板的設(shè)置,以便于我們?cè)谛陆ㄏ嚓P(guān)文檔時(shí)自動(dòng)生成注釋。
步驟:窗口->首選參數(shù)->flash builder->文本模板。在文本類型的窗口下面,提供了FB支持的所有文本的類型。這里我們只舉個(gè)AS類文本模板的示例。
a、展開ActionScript選項(xiàng),選擇ActionScript類。此時(shí)在下面的模板窗口里會(huì)顯示你當(dāng)前的AS類模板。
默認(rèn)是:這樣是不能滿足我們的要求的^_^。
b、點(diǎn)擊“文本類型”右面的編輯按鈕,會(huì)彈出模板編輯框:我們可以在這里修改我們想要的文本模板。
將文本改成如下格式:
${package_declaration} {
/**
* @author moge
* @E-mail: mochb-5718@163.com
* @version 1.0.0
* 創(chuàng)建時(shí)間:${date} ${time}
*
*/
${import_declaration}
${class_declaration}
{ ${class_body} } }
這樣我們新建一個(gè)AS類的時(shí)候就會(huì)自動(dòng)生成如開頭的注釋了。
對(duì)于有些使用系統(tǒng)變量的:${date} ${time},可以通過編輯框下面的“插入變量(I)...”查找。
3、快捷鍵快速添加注釋(ctrl+shift+d)。將鼠標(biāo)光標(biāo)放在需要注釋的函數(shù)體或者類體里,按下快捷鍵就可以了。
這種方法對(duì)于添加函數(shù)注釋非常方便, 但是對(duì)于類注釋好像內(nèi)容不全(可能需要其他地方設(shè)置,希望知道的同學(xué)告知^_^)。
AS類文件的模板設(shè)置就這些了,其他類型的文件大家自己玩。 對(duì)于已經(jīng)設(shè)置好的模板我們可以通過“文本類型”窗口右面的導(dǎo)出按鈕導(dǎo)出模板(xml文件),用于團(tuán)隊(duì)共享。