您好,登錄后才能下訂單哦!
這篇文章給大家介紹Flex代碼規范有哪些,內容非常詳細,感興趣的小伙伴們可以參考借鑒,希望對大家能有所幫助。
Flex代碼規范
1.前言
1.1目的
對于代碼,首要要求是它必須正確,能夠按照程序員的真實思想去運行;第二個的要求是代碼必須清晰易懂,使別的程序員能夠容易理解代碼所進行的實際工作。在軟件工程領域,源程序的風格統一標志著可讀性、可維護性、可重用性,是軟件項目的一個重要組成部分。而目前還沒有成文的編碼風格文檔,以至于很多時候,程序員沒有一個共同的標準可以遵守,編碼風格各異,程序可維護性差、可讀性也很差。通過建立代碼編寫規范,形成開發小組編碼約定,提高程序的可靠性、可讀性、可維護性、可繼承性和一致性,可以保證程序代碼的質量,繼承軟件開發成果,充分利用資源,使開發人員之間的工作成果可以共享。
本文在參考業界已有的編碼風格的基礎上,描述了一個基于Flex的項目風格,力求一種統一的編程風格,并從整體編碼風格、代碼文件風格、函數編寫風格、變量風格、注釋風格等幾個方面進行闡述。(這些規范并不是一定要絕對遵守,但是一定要讓程序有良好的可讀性);
我們確信FlexSDK的代碼不是一個人寫出來的,而到做到如此的規范與統一,我們也一定可以做到更高的標準。
2.Flex代碼規范的整體編碼風格
2.1縮進
縮進建議以4個空格為單位。Flex平臺中已將tab鍵默認設置為4個空格處理。
2.2對齊
(參閱flex源代碼格式)
2.3空行
(參閱Flex源代碼格式)
2.4注釋
注釋是軟件可讀性的具體體現。Flex代碼規范中程序注釋量一般占程序編碼量的20%,軟件工程要求不少于20%。程序注釋不能用抽象的語言,類似于"處理"、"循環"這樣的計算機抽象語言,要精確表達出程序的處理說明。例如:"計算凈需求"、"計算***道工序的加工工時"等。避免每行程序都使用注釋,可以在一段程序的前面加一段注釋,具有明確的處理邏輯。
注釋必不可少,但也不應過多,不要被動的為寫注釋而寫注釋。以下是四種必要的注釋:
A.標題、附加說明。
B.函數、類等的說明。
(參閱flex源代碼格式)
C.在代碼不明晰或不可移植處必須有一定的說明。
D.及少量的其它注釋,如自定義變量的注釋、代碼書寫時間等。
注釋有塊注釋和行注釋兩種,分別是指:"/**/"和"//"建議對A用塊注釋,D用行注釋,B、C則視情況而定,但應統一,至少在一個單元中B類注釋形式應統一。具體對不同文件、結構的注釋會在后面詳細說明。
2.5代碼長度
……
2.6頁寬
Flex代碼規范中頁寬應該設置為80字符。源代碼一般不會超過這個寬度,并導致無法完整顯示,但這一設置也可以靈活調整.在任何情況下,超長的語句應該在一個逗號或者一個操作符后折行.一條語句折行后,應該比原來的語句再縮進2個字符。
2.7行數
一般的集成編程環境下,每屏大概只能顯示不超過50行的程序,所以這個函數大概要5-6屏顯示,在某些環境下要8屏左右才能顯示完。這樣一來,無論是讀程序還是修改程序,都會有困難。因此建議把完成比較獨立功能的程序塊抽出,單獨成為一個函數。把完成相同或相近功能的程序塊抽出,獨立為一個子函數。可以發現,越是上層的函數越簡單,就是調用幾個子函數,越是底層的函數完成的越是具體的工作。這是好程序的一個標志。這樣,我們就可以在較上層函數里容易控制整個程序的邏輯,而在底層的函數里專注于某方面的功能的實現了。
關于Flex代碼規范有哪些就分享到這里了,希望以上內容可以對大家有一定的幫助,可以學到更多知識。如果覺得文章不錯,可以把它分享出去讓更多的人看到。
免責聲明:本站發布的內容(圖片、視頻和文字)以原創、轉載和分享為主,文章觀點不代表本網站立場,如果涉及侵權請聯系站長郵箱:is@yisu.com進行舉報,并提供相關證據,一經查實,將立刻刪除涉嫌侵權內容。