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

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

 

 

 

 

按照每一個文件的主要功能進行命名，使得程序文件的做用清晰透明，便於讀者把握脈絡。

數據放置和前端程序各自放置在目錄文件夾下，內容結構較爲清晰

文件名命名爲標準的駝峯式命名法

該源碼最大的優勢是使用了ini文件進行參數配置

 

 

 這樣使得參數配置集中且方便修改。

 

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

引用部分的代碼保留了相關轉載聲明。

 

 

 代碼內變量名及函數名單詞之間都用_分割，使得變量名清晰可讀。

代碼內註釋較爲詳盡（主要是搬運的官方文檔詳盡，添加部分的問題仍是不小） 

函數頭下方也會有函數變量註釋

 

 

 以及符號附近均用空格隔開，方便閱讀。

 

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

該套源碼的註釋及變量命名等沒有明顯的問題，可是整個程序的運行方式及環境配置方法均未作任何說明，且因爲距離發佈已通過去近兩年的時間，tf框架及其餘第三方包的的更新。須要至關的時間來進行debug，且調試到運行後仍沒法運行出合適的結果，須要重構部分代碼。

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

通常來講最好有對應的文獻來講明具體的原理，源碼以有明確的環境配置及運行流程爲上。

配合適當的圖解及必要的模塊註釋。