代碼規範總結

代碼規範的意義:

1,讓我們可以清晰的理清代碼邏輯,看懂代碼

2,便於維護,可擴展

3,應用程序的結構和編碼風格標準化,以便於閱讀和理解這段代碼

4、好的編碼約定可以使源代碼嚴禁,可讀性強且意義清楚,並且直觀。

代碼規範要注意的幾個方面:

1,註釋規範:

簡單來說分爲單行註釋,多行註釋,還有模塊頭部註釋

單行註釋爲:

多行註釋爲:

模塊頭註釋爲:

2,命名規範

命名規範可以使用pasal命名法和camel命名法

PasalCasing:標識符的第一個單詞的字母大寫

camelCasing:標識符的第一個單詞的字母小寫

3,編程規範

1>變量聲明:儘量不要把多個變量聲明在一行中,一行只聲明一個變量。

2>代碼縮進:保持一致的縮進,建議使用tab鍵,可以保證縮進距離相同。

3>大小寫問題:元素方法的參數和局部變量的第一個首字母小寫,後續的首字母均大寫,方法的每個單詞首字母都大寫

4>不要使用縮寫語,容易弄不清是什麼意思。

5>不要在標識符中使用下劃線。

6>要在接口前使用字母 I 。

7>要在類頂端定義所有成員變量,在最頂端定義靜態變量。

8>控制代碼行數,儘可能保持代碼簡潔

參考博客:

https://www.cnblogs.com/zhaoshujie/p/9594688.html

https://yq.aliyun.com/articles/597497

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