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

l  源代碼目錄結構

個人工程實踐題目是基於情感詞典的文本情感分析，我在網上找到了一個相似的項目，並對其源代碼進行分析。這個項目主要使用了python語言進行實現，具體結構以下圖所示：

 

 

 

 由圖可知該項目的目錄結構爲2層，其中文件夾存放的是項目所須要的測試數據、訓練數據以及情感詞典。根目錄下的文件有數據處理、提取訓練主題、測試等python文件，以及項目的結果等等。

l  文件名/類名/函數名/變量名等命名，接口定義規範和單元測試組織形式等方面的作法和特色

文件名、類名、函數名、變量名等命名都遵循了python語言的命名規則。接口定義規範也作到了準確，清晰地描述了接口的功能做用。

 

 

 

 

 

在單元測試中，中間環節主要使用的是print輸出的方式，對於整個項目有一套測試的數據來測試項目的可行性。

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

1. 標識符應當直觀且能夠拼讀，可望文知意，標識符的長度應當符合「min-length && max-information」原則
2. 註釋寫的全面，加強代碼的可讀性。
3. 儘可能避免名字中出現數字編號，除非邏輯上的確須要編號。
4. 常量全用大寫的字母，用下劃線分割單詞。

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

1. 靜態變量加前綴s_（表示static），全局變量加前綴g_，類的數據成員加前綴m_（表示member）。
2. 標識符最好採用英文單詞或其組合，便於記憶和閱讀。切忌使用漢語拼音來命名。

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

1. 全部的命名要規範，包括函數，變量等等。
2. 多寫註釋，針對各個函數，變量都要寫註釋來解釋其含義，當有難以理解的代碼出現時要有註釋解釋清楚。
3. Python中是以縮進來判斷代碼塊的，對代碼格式要求很是嚴格，不要胡亂使用tab或空格，不一樣級別的代碼要有不一樣的縮進，縮進量的錯誤會致使程序不能運行。