分析一套源代碼的代碼規範和風格並討論如何改進優化代碼

個人工程實踐選題是關於智能倉庫管理系統的設計與實現，後端開發目前是SpringMVC+Spring+Mybatis框架模式進行開發，而我在github上摘取的本項目是基於SSM的商品秒殺高併發項目。

結合工程實踐選題相關的一套源代碼，根據其編程語言或項目特色，分析其在源代碼目錄結構、文件名/類名/函數名/變量名等命名、接口定義規範和單元測試組織形式等方面的作法和特色。

代碼的目錄結構圖：

 

 

文件的命名方面，包名統一使用小寫，類名所有是開頭大寫的駝峯命名法。

 

 

函數名和變量名是使用開頭小寫的駝峯命名法。

 

 

 

對於接口的定義，一方面返回值的格式要統一，輸入參數要統一等等。

列舉哪些作法符合代碼規範和風格通常要求。

本項目package命名符合常規基於ssm項目的層次劃分，包括entity、service、dao等等。對於變量、函數、類等等都符合常規命名方法，名稱主要英文或者英文簡寫，沒有漢語拼音這種狀況。註釋也比較詳細，加強代碼的可讀性。

列舉哪些作法有悖於「代碼的簡潔、清晰、無歧義」的基本原則，及如何進一步優化改進。

在初始化變量時候等號先後有些地方有空格，有些地方沒空格。通常idea自動生成的是有空格的，不利於代碼美觀。其餘沒有大問題，總體代碼可讀性仍是能夠的。

總結同類編程語言或項目在代碼規範和風格的通常要求。

在命名格式方面：

大駝峯：類名。

小駝峯：方法名，變量名，參數名。

全大寫：常量名，單詞之間下劃線。

代碼書寫方面：

使用4個空格作縮進而不使用tab。

運算符左右兩邊必須加空格。

註釋雙斜線必須與註釋內容之間有且僅有一個空格。

方法參數在定義和傳入時，多個參數逗號後邊必須加空格。

左右小括號與括號內容之間不要出現空格。

單個方法不超過80行，單行字符不超過120。

控制語句必須使用大括號。

條件表達式中不能有賦值操做。

多層嵌套不能超過三層。

避免取反運算符。

註釋方面：

方法註釋/****/。

方法內使用//。