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

      個人工程實踐課題是《智能化倉儲管理平臺》,我從github上找到了一個相關的項目代碼。這個項目名稱叫作《基於SSM的先後端分離的倉儲管理系統》,該項目實現了包括出庫,入庫,訂單,盤點,揀貨等功能。php

      該項目在github上的具體框架如圖:前端

 

         該項目在後端主要應用了Spring+SpringMVC+MyBatis,緩存使用了Redis,並使用了Spring Cache的緩存註解,能夠直接應用到方法上。在前端使用了阿里巴巴開源的lceworks構建。具體代碼框架是這樣的java

 

         部分代碼以下:git

 

         能夠看到這段代碼格式規範,簡練,還加了註釋方便他人閱讀。程序員

 

         總結同類編程語言或項目在代碼規範和風格的通常要求:好的編程風格當然重要,可是你必定據說過一些程序員的我的風格。其實咱們徹底沒必要爲那些所謂條條框框所累,可是做爲原則是咱們至少不能打破這些常規。咱們應該在保持本身風格的同時儘可能的把本身與編程潛原則靠攏。

可讀性很容易達到,好比,讓本身的代碼縮排排列、名字採用描述性但不要過長(短名應僅僅用在非遠程)、特殊名稱好比pi應當被定義爲final類型。模塊性是編程須要注意的另外一重點,把代碼劃分到類裏,在類中把功能劃分到方法中,別讓一個類太大,不然在使用、修改和理解上都會形成沒必要要的麻煩,方法也同樣,若是一個方法長度超過50行,它產生錯誤的機率將接近100%,儘可能把大方法劃分爲小方法,編程中爲避免重複編寫,還應儘可能調用JAVA標準類庫。

儘可能避免在寫代碼和註釋時使用不一樣語言,常常見到論壇有朋友詢問諸如在java中調用c、調用php、調用shell之類的問題,其實在編程中,咱們應儘可能使用一種語言去完成事情。另外就是沒必要最優化本身的代碼,應該選擇相對較優的算法就能夠了。github

相關文章
相關標籤/搜索