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

这里选择了github上的一个开源项目：360Controller作介绍，分析这套源代码的代码规范和风格并讨论如何改进优化代码。

1、源代码目录结构、文件名/类名/函数名/变量名等命名、接口定义规范和单元测试组织形式等方面的作法和特色

·源代码目录结构示例以下：

能够看到这里的目录结构十分的清晰，可让人明白的看出整个项目的组织结构和文件架构，特别的方便开发人员或者学习者的使用阅读。

 

·文件名示例以下：

大多数的文件的做用均可以从文件名中直观的看出来，方便开发人员的使用。

 

·类名命名和类结构示例以下：

采用驼峰命名法，彻底按照软件编写规范来要求。

 

 

·函数名命名示例以下：

 

 

·变量名命名示例以下：

 

 

2、列举哪些作法符合代码规范和风格通常要求

·在文件名、类名、函数名、变量名命名方面都使用驼峰命名法，这一点很是符合程序设计规范，使读者很是方便的知晓表达的意思。下图看的十分明显：

 

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

·在某些大段代码中缺少注释，使阅读十分麻烦，以下：

 

4、总结同类编程语言或项目在代码规范和风格的通常要求

代码规范化基本上有七大原则，体如今空行、空格、成对书写、缩进、对齐、代码行、注释七方面的书写规范上。

一、空行

空行起着分隔程序段落的做用。空行得体将使程序的布局更加清晰。空行不会浪费内存，虽然打印含有空行的程序会多消耗一些纸张，可是值得。

规则一：定义变量后要空行。尽量在定义变量的同时初始化该变量，即遵循就近原则。若是变量的引用和定义相隔比较远，那么变量的初始化就很容易被忘记。若引用了未被初始化的变量，就会致使程序出错。

规则二：每一个函数定义结束以后都要加空行。

总规则：两个相对独立的程序块、变量说明以后必需要加空行。好比上面几行代码完成的是一个功能，下面几行代码完成的是另外一个功能，那么它们中间就要加空行。这样看起来更清晰。

二、空格

规则一：关键字以后要留空格。像 const、case 等关键字以后至少要留一个空格，不然没法辨析关键字。像 if、for、while 等关键字以后应留一个空格再跟左括号(，以突出关键字。

规则二：函数名以后不要留空格，应紧跟左括号(，以与关键字区别。

规则三：(向后紧跟；)、,、;这三个向前紧跟；紧跟处不留空格。

规则四：,以后要留空格。若是;不是一行的结束符号，其后要留空格。

规则五：赋值运算符、关系运算符、算术运算符、逻辑运算符、位运算符，如 =、==、！=、+=、－=、*=、/=、%=、>>=、<<=、&=、^=、|=、>、<=、>、>=、+、－、*、/、%、&、|、&&、||、<<、>>、^ 等双目运算符的先后应当加空格。

注意，运算符“%”是求余运算符，与 printf 中 %d 的“%”不一样，因此 %d 中的“%”先后不用加空格。

规则六：单目运算符 !、~、++、－－、－、*、& 等先后不加空格。

注意：

这里的“－”和规则五里面的“－”不一样。这里的“－”是负号运算符，规则五里面的“－”是减法运算符。
这里的“*”和规则五里面的“*”也不一样。这里的“*”是指针运算符，规则五里面的“*”是乘法运算符。
这里的“&”和规则五里面的“&”也不一样。这里的“&”是取地址运算符，规则五里面的“&”是按位与运算符。

总之，规则六中的是单目运算符，而规则五中的是双目运算符，它们是不同的。

规则七：像数组符号[]、结构体成员运算符.、指向结构体成员运算符->，这类操做符先后不加空格。

规则八：对于表达式比较长的 for 语句和 if 语句，为了紧凑起见，能够适当地去掉一些空格。但 for 和 if 后面紧跟的空格不能够删，其后面的语句能够根据语句的长度适当地去掉一些空格。例如：

for (i=0; i<10; i++)

for 和分号后面保留空格就能够了，=和<先后的空格可去掉。

三、成对书写

成对的符号必定要成对书写，如 ()、{}。不要写完左括号而后写内容最后再补右括号，这样很容易漏掉右括号，尤为是写嵌套程序的时候。

四、缩进

缩进是经过键盘上的 Tab 键实现的，缩进可使程序更有层次感。原则是：若是地位相等，则不须要缩进；若是属于某一个代码的内部代码就须要缩进。

五、对齐

对齐主要是针对大括号{}说的：

规则一：{和}分别都要独占一行。互为一对的{和}要位于同一列，而且与引用它们的语句左对齐。

规则二：{}以内的代码要向内缩进一个 Tab，且同一地位的要左对齐，地位不一样的继续缩进。

还有须要注意的是，不少编程软件是会“自动对齐”的。

此外编程软件还有“对齐、缩进修正”功能。就是按 Ctrl+A 全选，而后按 Alt+F8，这时程序中全部成对的大括号都会自动对齐，未缩进的也会自动缩进。不论是在编程过程当中，仍是在编写结束完以后，均可以使用这个技巧。但若是彻底按照规范写，那根本就不须要这个技巧，因此，这只是一个辅助功能。

六、代码行

规则一：一行代码只作一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，而且便于写注释。

规则二：if、else、for、while、do 等语句自占一行，执行语句不得紧跟其后。此外，很是重要的一点是，不论执行语句有多少行，就算只有一行也要加{}，而且遵循对齐的原则，这样能够防止书写失误。

七、注释

C语言中一行注释通常采用//…，多行注释必须采用/*…*/。注释一般用于重要的代码行或段落提示。在通常状况下，源程序有效注释量必须在 20% 以上。虽然注释有助于理解代码，但注意不可过多地使用注释。

规则一：注释是对代码的“提示”，而不是文档。程序中的注释不可喧宾夺主，注释太多会让人眼花缭乱。

规则二：若是代码原本就是清楚的，则没必要加注释。

规则三：边写代码边注释，修改代码的同时要修改相应的注释，以保证注释与代码的一致性，再也不有用的注释要删除。

规则四：当代码比较长，特别是有多重嵌套的时候，应当在段落的结束处加注释，这样便于阅读。

规则五：每一条宏定义的右边必需要有注释，说明其做用。