代碼規範

俗話說沒有規矩不成方圓,國有國法家有家規,每個行業有自己的規範,代碼自然也就有代碼的規範。

代碼規範七大原則

1.空行

空行起着分隔程序段落的作用。空行得體將使程序的佈局更加清晰。空行不會浪費內存。

規則一:定義變量後要空行。儘可能在定義變量的同時初始化該變量,即遵循就近原則。如果變量的引用和定義相隔比較遠,那麼變量的初始化就很容易被忘記。若引用了未被初始化的變量,就會導致程序出錯。

規則二:每個函數定義結束之後都要加空行。

總規則:兩個相對獨立的程序塊、變量說明之後必須要加空行。比如上面幾行代碼完成的是一個功能,下面幾行代碼完成的是另一個功能,那麼它們中間就要加空行。這樣看起來更清晰

2.空格

規則一:關鍵字之後要留空格。

規則二:函數名之後不要留空格

3。成對書寫

成對的符號一定要成對書寫,如 ()、{}。不要寫完左括號然後寫內容最後再補右括號,這樣很容易漏掉右括號,尤其是寫嵌套程序的時候。

4.縮進

縮進是通過鍵盤上的 Tab 鍵實現的,縮進可以使程序更有層次感。原則是:如果地位相等,則不需要縮進;如果屬於某一個代碼的內部代碼就需要縮進。

5.對齊

對齊主要是針對大括號{}說的:

規則一:{}分別都要獨佔一行。互爲一對的{}要位於同一列,並且與引用它們的語句左對齊。

規則二:{}之內的代碼要向內縮進一個 Tab,且同一地位的要左對齊,地位不同的繼續縮進。

6.代碼行

規則一:一行代碼只做一件事情,如只定義一個變量,或只寫一條語句。這樣的代碼容易閱讀,並且便於寫註釋。

規則二:if、else、for、while、do 等語句自佔一行,執行語句不得緊跟其後。此外,非常重要的一點是,不論執行語句有多少行,就算只有一行也要加{},並且遵循對齊的原則,這樣可以防止書寫失誤。

7.註釋

規則一:註釋是對代碼的“提示”,而不是文檔。程序中的註釋不可喧賓奪主,註釋太多會讓人眼花繚亂。

規則二:如果代碼本來就是清楚的,則不必加註釋。

規則三:邊寫代碼邊註釋,修改代碼的同時要修改相應的註釋,以保證註釋與代碼的一致性,不再有用的註釋要刪除。

規則四:當代碼比較長,特別是有多重嵌套的時候,應當在段落的結束處加註釋,這樣便於閱讀。

規則五:每一條宏定義的右邊必須要有註釋,說明其作用

 

代碼規範化的好處

代碼規範化的第一個好處就是看着很整齊、很舒服。假如你現在用不規範的方式寫了一萬行代碼,現在能看得懂,但等過了三個月你再回頭看時就很吃力了,更不要說給別人看了。所以代碼要寫規範,比如加註釋就是代碼規範化的一個思想。

在一般情況下,根據軟件工程的思想,我們的註釋要佔整個文檔的20%以上。所以註釋要寫得很詳細,而且格式要寫得很規範。

第二個好處是,把代碼寫規範則程序不容易出錯。如果按照不規範的格式輸入代碼的話,很容易出錯。而代碼寫規範的話即使出錯了查錯也會很方便。格式雖然不會影響程序的功能,但會影響可讀性。程序的格式追求清晰、美觀,是程序風格的重要構成元素。

發佈了39 篇原創文章 · 獲贊 9 · 訪問量 6919
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章