Flex代碼規(guī)范詳盡解讀
本文和大家重點討論一下Flex代碼規(guī)范，這是公司項目組成員在實際開發(fā)中總結(jié)的Flex代碼規(guī)范，放在下面分享，歡迎大家一起學(xué)習(xí)?！ ?/p>
Flex代碼規(guī)范
1.前言
1.1目的
對于代碼，首要要求是它必須正確，能夠按照程序員的真實思想去運行；第二個的要求是代碼必須清晰易懂，使別的程序員能夠容易理解代碼所進(jìn)行的實際工作。在軟件工程領(lǐng)域，源程序的風(fēng)格統(tǒng)一標(biāo)志著可讀性、可維護性、可重用性，是軟件項目的一個重要組成部分。而目前還沒有成文的編碼風(fēng)格文檔，以至于很多時候，程序員沒有一個共同的標(biāo)準(zhǔn)可以遵守，編碼風(fēng)格各異，程序可維護性差、可讀性也很差。通過建立代碼編寫規(guī)范，形成開發(fā)小組編碼約定，提高程序的可靠性、可讀性、可維護性、可繼承性和一致性，可以保證程序代碼的質(zhì)量，繼承軟件開發(fā)成果，充分利用資源，使開發(fā)人員之間的工作成果可以共享。
本文在參考業(yè)界已有的編碼風(fēng)格的基礎(chǔ)上，描述了一個基于Flex的項目風(fēng)格，力求一種統(tǒng)一的編程風(fēng)格，并從整體編碼風(fēng)格、代碼文件風(fēng)格、函數(shù)編寫風(fēng)格、變量風(fēng)格、注釋風(fēng)格等幾個方面進(jìn)行闡述。（這些規(guī)范并不是一定要絕對遵守，但是一定要讓程序有良好的可讀性）；
我們確信FlexSDK的代碼不是一個人寫出來的，而到做到如此的規(guī)范與統(tǒng)一，我們也一定可以做到更高的標(biāo)準(zhǔn)。
2.Flex代碼規(guī)范的整體編碼風(fēng)格
2.1縮進(jìn)
縮進(jìn)建議以4個空格為單位。Flex平臺中已將tab鍵默認(rèn)設(shè)置為4個空格處理。
2.2對齊
(參閱flex源代碼格式)
2.3空行
(參閱Flex源代碼格式)
2.4注釋
注釋是軟件可讀性的具體體現(xiàn)。Flex代碼規(guī)范中程序注釋量一般占程序編碼量的20%，軟件工程要求不少于20%。程序注釋不能用抽象的語言，類似于"處理"、"循環(huán)"這樣的計算機抽象語言，要精確表達(dá)出程序的處理說明。例如："計算凈需求"、"計算***道工序的加工工時"等。避免每行程序都使用注釋，可以在一段程序的前面加一段注釋，具有明確的處理邏輯。
注釋必不可少，但也不應(yīng)過多，不要被動的為寫注釋而寫注釋。以下是四種必要的注釋：
A.標(biāo)題、附加說明。
B.函數(shù)、類等的說明。
(參閱flex源代碼格式)
C.在代碼不明晰或不可移植處必須有一定的說明。
D.及少量的其它注釋，如自定義變量的注釋、代碼書寫時間等。
注釋有塊注釋和行注釋兩種，分別是指："/**/"和"//"建議對A用塊注釋，D用行注釋，B、C則視情況而定，但應(yīng)統(tǒng)一，至少在一個單元中B類注釋形式應(yīng)統(tǒng)一。具體對不同文件、結(jié)構(gòu)的注釋會在后面詳細(xì)說明。
2.5代碼長度
……
2.6頁寬
Flex代碼規(guī)范中頁寬應(yīng)該設(shè)置為80字符。源代碼一般不會超過這個寬度,并導(dǎo)致無法完整顯示,但這一設(shè)置也可以靈活調(diào)整.在任何情況下,超長的語句應(yīng)該在一個逗號或者一個操作符后折行.一條語句折行后,應(yīng)該比原來的語句再縮進(jìn)2個字符。
2.7行數(shù)
一般的集成編程環(huán)境下，每屏大概只能顯示不超過50行的程序，所以這個函數(shù)大概要5-6屏顯示，在某些環(huán)境下要8屏左右才能顯示完。這樣一來，無論是讀程序還是修改程序，都會有困難。因此建議把完成比較獨立功能的程序塊抽出，單獨成為一個函數(shù)。把完成相同或相近功能的程序塊抽出，獨立為一個子函數(shù)?？梢园l(fā)現(xiàn)，越是上層的函數(shù)越簡單，就是調(diào)用幾個子函數(shù)，越是底層的函數(shù)完成的越是具體的工作。這是好程序的一個標(biāo)志。這樣，我們就可以在較上層函數(shù)里容易控制整個程序的邏輯，而在底層的函數(shù)里專注于某方面的功能的實現(xiàn)了。
【編輯推薦】
