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

我的项目是少儿编程平台的开发，在GitHub上找到了一套相关的源码。并对其进行分析。源代码目录结构如下所示。

 

如上图所示，该项目文件目录结构的层次比较清晰，命名也符合规范，让参考者可以清楚的了解到他们的功能和作用。

 

 上图截取了部分代码，用于分析文件名/类名/函数名/变量名等命名是否合乎规则。

1）这个java的文件名是SaveProgress，和public类SaveProgress的名称相同，符合java的语法规则。

2）Java约定俗成的，类名的每个单词首字母大写。显然也符合这一规范。

3）再看变量的命名，也是符合第一个单词首字母小写，之后单词首字母大写的规则

4）此外，每个变量名都是有意义的单词组成的，方便读者理解。

5）方法名和变量名相同，都遵循第一个单词首字母消息，之后单词首字母大写的规则

 

 如上图所示，是这套代码里定义的一个接口。在Java中，接口是不能实例化的，但接口可以由继承他的类或对象负责实现相应的功能。接口中的方法默认为public。显然以上代码符合接口定义的规范。

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

就像我之前分析的一样，这套代码的文件名，类名，包名，变量名都符合java的命名规范，并遵循了一些约定俗称的规则。文件目录的格式清晰，布局合理。

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

我download的这套代码虽然格式清晰，命名也符合规范，但有个最大的问题是基本没有注释，这让用户的阅读体验得不到保障，增大了别人阅读这套代码的困难度。此外，这套代码并没有进行单元测试工作，这是一个需要改进的地方。我在日后的开发工作中，需要避免出现这种问题。首先，多写注释，其次，增加单元测试模块，让我的代码更健壮。

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

1）符合规范的文件名，变量名，类名，方法名和函数名等。

一个符合规范的命名会提升阅读的效率，加速对代码的理解。

2）良好的排版（缩进）

良好的排版同样可以提升阅读的效率，同时也会提升开发的效率。因为好的排版能愉悦人的心灵，而一个差的排版可能会带来负面的心情。

3）适量的语义清晰的注释

过少的注释会增大理解的难度，过量的注释会让代码变得凌乱，而适量的注释会带来全新的阅读体验。

4）全面的单元测试

全面的单元测试会及时发现我们的问题，帮助我们更好的完善我们的代码。