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

一.結合工程實踐選題相關的一套源代碼,根據其編程語言或項目特色,分析其在源代碼目錄結構,文件名、類名,函數名,變量名等命名,接口定義規範等方面的作法和特色:java

從如下目錄結構可見,該源代碼結構清晰編程

    

如下面這段代碼爲例來分析該源碼在文件名,類名,函數名以及變量名等命名方面的規範特色:編程語言

 

  1. 包命名規範符合要求,包名採用後綴倒置加上自定義,採用小寫字母。
  2. 類名和接口定義符合規範,使用每一個英文單詞首字母大寫的大小寫混合命名法。
  3. 方法名命名符合命名規範,java中,方法名的第一個單詞首字母用小寫,剩餘單詞使用首字母大寫其他字母小寫的大小寫混合法。
  4. 屬性名命名符合規範,與方法名命名規範相似,即第一個單詞小寫剩餘單詞大小寫混合,另外須要注意的是屬性名不能與方法名相同。
  5. 常量命名規範,使用全大寫英文,單詞之間使用下劃線分隔開。

二.列舉哪些作法符合代碼規範和風格通常要求:函數

        1.該源碼的文件名,類名,函數名,變量名等等的定義都符合規劃要求。測試

        2.代碼之間的空行,每段代碼前面的縮進都有利於增長源碼的易讀性。設計

        3.在相應的代碼旁邊作有註釋有利於後期維護與更新。3d

三.同類編程語言在代碼規範和風格上的通常要求:代碼規範

        1.類名首字母要大寫,字段,方法和對象的首字母應該小寫,對於全部標識符,其中所包含的單詞都應緊靠在一塊兒,對象

        2.將方法設計成簡要的功能性單元,方法要簡明扼要。blog

        3.要儘量多加註釋,提升可讀性。

        4.儘可能使用interfaces,不要使用abstract類。

        5.花括號的使用要遵循 K&R 風格。

        6.對於本身建立的每個類,都要加入一個main函數來測試那個類的代碼。

        。。。。。。

相關文章
相關標籤/搜索