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

　　我的工程实践选题是《基于情感词典的文本情感分析》，所以我在github上面下载了一套与其相关的源代码并且进行了分析。

• 根据其编程语言或项目特点，分析其在源代码目录结构、文件名/类名/函数名/变量名等命名、接口定义规范和单元测试组织形式等方面的做法和特点

1. 源代码目录结构

　　　　该项目使用python语言进行开发的，其源代码目录结构为：

　　　　

由图可知该项目的目录结构为2层，有一个专门的文件夹存放项目所需要的测试数据、训练数据以及情感词典。根目录下有数据处理、提取训练主题、测试等python文件，还有项目的结果等。

　　2.　文件名/类名/函数名/变量名等命名规范

　　文件名、类名、函数名、变量名等命名都遵守python语言的命名规则，并且其意思都非常明确。例如获取新的情感词的函数。

• 列举哪些做法符合代码规范和风格一般要求

1. 命名要规范，并且要展示对象的功能
2. 合理的缩进方式，让代价简单整洁
3. 合理的组织代码结构，做到高内聚，低耦合，尽量不要编写重复的代码
4. 少用全局变量
5. 拥有注释说明，对于难理解的代码养成写注释的习惯

 

• 列举哪些做法有悖于“代码的简洁、清晰、无歧义”的基本原则，及如何进一步优化改进

1. 命名不规范，例如随意命名可能会让一些变量的含义不清晰，影响代码的理解。所以所有的变量，方法名和类名都应该遵循骆驼命名法
2. 代码重复，这也会严重影响代码的简洁性，可以将重复代码所实现的功能封装成函数来进行调用。

• 总结同类编程语言或项目在代码规范和风格的一般要求

1. 多写注释，将函数的功能、变量的含义等用注释写出来
2. 少使用缩写，所有类型、方法、参数、变量的命名尽量不要使用缩写
3. 使用Tab作为缩进，并设置缩进大小为4