分析一套源代码的代码规范和风格并讨论如何改进优化代码

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或空格，不同级别的代码要有不同的缩进，缩进量的错误会导致程序不能运行。