Flex代碼規(guī)范有哪些

這篇文章給大家介紹Flex代碼規(guī)范有哪些，內(nèi)容非常詳細(xì)，感興趣的小伙伴們可以參考借鑒，希望對(duì)大家能有所幫助。

Flex代碼規(guī)范

1.前言

1.1目的

對(duì)于代碼，首要要求是它必須正確，能夠按照程序員的真實(shí)思想去運(yùn)行；第二個(gè)的要求是代碼必須清晰易懂，使別的程序員能夠容易理解代碼所進(jìn)行的實(shí)際工作。在軟件工程領(lǐng)域，源程序的風(fēng)格統(tǒng)一標(biāo)志著可讀性、可維護(hù)性、可重用性，是軟件項(xiàng)目的一個(gè)重要組成部分。而目前還沒(méi)有成文的編碼風(fēng)格文檔，以至于很多時(shí)候，程序員沒(méi)有一個(gè)共同的標(biāo)準(zhǔn)可以遵守，編碼風(fēng)格各異，程序可維護(hù)性差、可讀性也很差。通過(guò)建立代碼編寫(xiě)規(guī)范，形成開(kāi)發(fā)小組編碼約定，提高程序的可靠性、可讀性、可維護(hù)性、可繼承性和一致性，可以保證程序代碼的質(zhì)量，繼承軟件開(kāi)發(fā)成果，充分利用資源，使開(kāi)發(fā)人員之間的工作成果可以共享。

本文在參考業(yè)界已有的編碼風(fēng)格的基礎(chǔ)上，描述了一個(gè)基于Flex的項(xiàng)目風(fēng)格，力求一種統(tǒng)一的編程風(fēng)格，并從整體編碼風(fēng)格、代碼文件風(fēng)格、函數(shù)編寫(xiě)風(fēng)格、變量風(fēng)格、注釋風(fēng)格等幾個(gè)方面進(jìn)行闡述。（這些規(guī)范并不是一定要絕對(duì)遵守，但是一定要讓程序有良好的可讀性）；
我們確信FlexSDK的代碼不是一個(gè)人寫(xiě)出來(lái)的，而到做到如此的規(guī)范與統(tǒng)一，我們也一定可以做到更高的標(biāo)準(zhǔn)。

2.Flex代碼規(guī)范的整體編碼風(fēng)格

2.1縮進(jìn)

縮進(jìn)建議以4個(gè)空格為單位。Flex平臺(tái)中已將tab鍵默認(rèn)設(shè)置為4個(gè)空格處理。

2.2對(duì)齊

(參閱flex源代碼格式)

2.3空行

(參閱Flex源代碼格式)

2.4注釋

注釋是軟件可讀性的具體體現(xiàn)。Flex代碼規(guī)范中程序注釋量一般占程序編碼量的20%，軟件工程要求不少于20%。程序注釋不能用抽象的語(yǔ)言，類似于"處理"、"循環(huán)"這樣的計(jì)算機(jī)抽象語(yǔ)言，要精確表達(dá)出程序的處理說(shuō)明。例如："計(jì)算凈需求"、"計(jì)算***道工序的加工工時(shí)"等。避免每行程序都使用注釋，可以在一段程序的前面加一段注釋，具有明確的處理邏輯。
注釋必不可少，但也不應(yīng)過(guò)多，不要被動(dòng)的為寫(xiě)注釋而寫(xiě)注釋。以下是四種必要的注釋：
A.標(biāo)題、附加說(shuō)明。
B.函數(shù)、類等的說(shuō)明。
(參閱flex源代碼格式)
C.在代碼不明晰或不可移植處必須有一定的說(shuō)明。
D.及少量的其它注釋，如自定義變量的注釋、代碼書(shū)寫(xiě)時(shí)間等。
注釋有塊注釋和行注釋兩種，分別是指："/**/"和"//"建議對(duì)A用塊注釋，D用行注釋，B、C則視情況而定，但應(yīng)統(tǒng)一，至少在一個(gè)單元中B類注釋形式應(yīng)統(tǒng)一。具體對(duì)不同文件、結(jié)構(gòu)的注釋會(huì)在后面詳細(xì)說(shuō)明。

2.5代碼長(zhǎng)度
……

2.6頁(yè)寬

Flex代碼規(guī)范中頁(yè)寬應(yīng)該設(shè)置為80字符。源代碼一般不會(huì)超過(guò)這個(gè)寬度,并導(dǎo)致無(wú)法完整顯示,但這一設(shè)置也可以靈活調(diào)整.在任何情況下,超長(zhǎng)的語(yǔ)句應(yīng)該在一個(gè)逗號(hào)或者一個(gè)操作符后折行.一條語(yǔ)句折行后,應(yīng)該比原來(lái)的語(yǔ)句再縮進(jìn)2個(gè)字符。

2.7行數(shù)

一般的集成編程環(huán)境下，每屏大概只能顯示不超過(guò)50行的程序，所以這個(gè)函數(shù)大概要5-6屏顯示，在某些環(huán)境下要8屏左右才能顯示完。這樣一來(lái)，無(wú)論是讀程序還是修改程序，都會(huì)有困難。因此建議把完成比較獨(dú)立功能的程序塊抽出，單獨(dú)成為一個(gè)函數(shù)。把完成相同或相近功能的程序塊抽出，獨(dú)立為一個(gè)子函數(shù)。可以發(fā)現(xiàn)，越是上層的函數(shù)越簡(jiǎn)單，就是調(diào)用幾個(gè)子函數(shù)，越是底層的函數(shù)完成的越是具體的工作。這是好程序的一個(gè)標(biāo)志。這樣，我們就可以在較上層函數(shù)里容易控制整個(gè)程序的邏輯，而在底層的函數(shù)里專注于某方面的功能的實(shí)現(xiàn)了。

關(guān)于Flex代碼規(guī)范有哪些就分享到這里了，希望以上內(nèi)容可以對(duì)大家有一定的幫助，可以學(xué)到更多知識(shí)。如果覺(jué)得文章不錯(cuò)，可以把它分享出去讓更多的人看到。