通常來說,在任何一個項目組中都應(yīng)該有各自的編碼規(guī)范,目的就是為了增加代碼的可讀性和可維護(hù)性,那么,到底該如何做呢?
1/7分步閱讀
變量命名要有意義,最好是使用英文命名,實在不行的,使用拼音。除了循環(huán)中的計數(shù)變量,以及特殊場景之外,任何變量都盡量不要使用a、b、c這類完全沒有任何意義的名稱。增強可讀性
2/7
變量除了要有意義之外,還需要統(tǒng)一大小寫,比如第一個單詞首字母小寫,后續(xù)單詞首字母大寫的命名風(fēng)格。風(fēng)格統(tǒng)一后,看著代碼都會心情舒暢一些,從而可讀性更好
3/7
添加必要的注釋,雖然,某些變量名可以看出意義,但是,必要的注釋可以更為直觀的讓人看懂代碼,增強可讀性
4/7
增加代碼段的注釋。如果是C#語言,可以使用region語法包裹一段邏輯,到時候折疊起來,看起來整體性就很容易閱讀。其他語言可以使用比較明顯的分隔符號標(biāo)明段落
5/7
將很長的函數(shù)拆分成較小的函數(shù),這樣不僅可以增加代碼的可讀性,還能增加代碼的可維護(hù)性
6/7
將代碼劃分層次,比如,訪問數(shù)據(jù)庫的代碼單獨放在一個項目中,前臺代碼單獨放一個項目中,到時候修改的時候就很明確,不至于四處亂找,增加可維護(hù)性
7/7
代碼的層次之間通過接口來調(diào)用,減少各個層次之間的耦合度,增加可維護(hù)性