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

個人工程實踐選題是《關於物聯網組網方案的搜索引擎》，屬於定向搜索引擎的一種，因此我在GitHub上下載了一個搜索引擎相關的源碼進行分析。

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

1.源代碼目錄結構

 

2.文件名/類名/函數名/變量名等命名規範

 

 

 

 

 

 

 3.格式規範

　　 1.函數命名採起小寫字母+下劃線的組合，可以讓閱讀人員快速瞭解做者定義函數的目的。

　　 2.每一個函數以前會寫明輸入與功能，在接口格式上比較規範

 

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

 

1. 函數前會寫明功能，

2. 命名函數/類時以英文功能名稱來命名，方便閱讀

3. 註明了編碼格式（使用UTF-8編碼）

 

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

 

　　不少核心代碼沒有註釋，不方便閱讀與修改。在時間等條件容許的狀況下，應儘可能使每一條代碼都有註釋

 

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

　　1.命名應該以功能爲主，格式要統一規範，方便閱讀；

　　2.核心代碼應有註釋，方便後來人學習，改進；

　　3.使用UTF-8編碼

　　4.類內方法空1行分隔，類外空2行分隔

　　5.1個前導下劃線表示半公開，2個前導下劃線表示私有，與保留字區分使用單個後置下劃線