这里选择了github上的一个开源项目：360Controller做介绍，分析这套源代码的代码规范和风格并讨论如何改进优化代码。
一、源代码目录结构、文件名/类名/函数名/变量名等命名、接口定义规范和单元测试组织形式等方面的做法和特点
·····源代码目录结构示例如下：
可以看到这里的目录结构十分的清晰，可以让人明白的看出整个项目的组织结构和文件架构，特别的方便开发人员或者学习者的使用阅读。
·····文件名示例如下：
大多数的文件的作用都可以从文件名中直观的看出来，方便开发人员的使用。
·····类名命名和类结构示例如下：
采用驼峰命名法，完全按照软件编写规范来要求。
·····函数名命名示例如下：
驼峰命名法。
·····变量名命名示例如下：
驼峰命名法。
二、列举哪些做法符合代码规范和风格一般要求
·····在文件名、类名、函数名、变量名命名方面都使用驼峰命名法，这一点非常符合程序设计规范，使读者非常方便的知晓表达的意思。下图看的十分明显：
三、列举哪些做法有悖于“代码的简洁、清晰、无歧义”的基本原则，及如何进一步优化改进
在某些大段代码中缺乏注释，使阅读十分麻烦，如下：
四、总结同类编程语言或项目在代码规范和风格的一般要求
代码规范化基本上有七大原则，体现在空行、空格、成对书写、缩进、对齐、代码行、注释七方面的书写规范上。
1、空行
空行起着分隔程序段落的作用。空行得体将使程序的布局更加清晰。空行不会浪费内存，虽然打印含有空行的程序会多消耗一些纸张，但是值得。
规则一：定义变量后要空行。尽可能在定义变量的同时初始化该变量，即遵循就近原则。如果变量的引用和定义相隔比较远，那么变量的初始化就很容易被忘记。若引用了未被初始化的变量，就会导致程序出错。
规则二：每个函数定义结束之后都要加空行。
总规则：两个相对独立的程序块、变量说明之后必须要加空行。比如上面几行代码完成的是一个功能，下面几行代码完成的是另一个功能，那么它们中间就要加空行。这样看起来更清晰。
2、空格
规则一：关键字之后要留空格。像 const、case 等关键字之后至少要留一个空格，否则无法辨析关键字。像 if、for、while 等关键字之后应留一个空格再跟左括号(，以突出关键字。
规则二：函数名之后不要留空格，应紧跟左括号(，以与关键字区别。
规则三：(向后紧跟；)、,、;这三个向前紧跟；紧跟处不留空格。
规则四：,之后要留空格。如果;不是一行的结束符号，其后要留空格。
规则五：赋值运算符、关系运算符、算术运算符、逻辑运算符、位运算符，如 =、==、！=、+=、－=、*=、/=、%=、>>=、<<=、&=、^=、|=、>、<=、>、>=、+、－、*、/、%、&、|、&&、||、<<、>>、^ 等双目运算符的前后应当加空格。
注意，运算符“%”是求余运算符，与 printf 中 %d 的“%”不同，所以 %d 中的“%”前后不用加空格。
规则六：单目运算符 !、~、++、－－、－、*、& 等前后不加空格。
注意：
这里的“－”和规则五里面的“－”不同。这里的“－”是负号运算符，规则五里面的“－”是减法运算符。
这里的“*”和规则五里面的“*”也不同。这里的“*”是指针运算符，规则五里面的“*”是乘法运算符。
这里的“&”和规则五里面的“&”也不同。这里的“&”是取地址运算符，规则五里面的“&”是按位与运算符。
总之，规则六中的是单目运算符，而规则五中的是双目运算符，它们是不一样的。
规则七：像数组符号[]、结构体成员运算符.、指向结构体成员运算符->，这类操作符前后不加空格。
规则八：对于表达式比较长的 for 语句和 if 语句，为了紧凑起见，可以适当地去掉一些空格。但 for 和 if 后面紧跟的空格不可以删，其后面的语句可以根据语句的长度适当地去掉一些空格。例如：
for (i=0; i<10; i++)
for 和分号后面保留空格就可以了，=和<前后的空格可去掉。
3、成对书写
成对的符号一定要成对书写，如 ()、{}。不要写完左括号然后写内容最后再补右括号，这样很容易漏掉右括号，尤其是写嵌套程序的时候。
4、缩进
缩进是通过键盘上的 Tab 键实现的，缩进可以使程序更有层次感。原则是：如果地位相等，则不需要缩进；如果属于某一个代码的内部代码就需要缩进。
5、对齐
对齐主要是针对大括号{}说的：
规则一：{和}分别都要独占一行。互为一对的{和}要位于同一列，并且与引用它们的语句左对齐。
规则二：{}之内的代码要向内缩进一个 Tab，且同一地位的要左对齐，地位不同的继续缩进。
还有需要注意的是，很多编程软件是会“自动对齐”的。
此外编程软件还有“对齐、缩进修正”功能。就是按 Ctrl+A 全选，然后按 Alt+F8，这时程序中所有成对的大括号都会自动对齐，未缩进的也会自动缩进。不管是在编程过程中，还是在编写结束完之后，都可以使用这个技巧。但如果完全按照规范写，那根本就不需要这个技巧，所以，这只是一个辅助功能。
6、代码行
规则一：一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且便于写注释。
规则二：if、else、for、while、do 等语句自占一行，执行语句不得紧跟其后。此外，非常重要的一点是，不论执行语句有多少行，就算只有一行也要加{}，并且遵循对齐的原则，这样可以防止书写失误。
7、注释
C语言中一行注释一般采用//…，多行注释必须采用/*…*/。注释通常用于重要的代码行或段落提示。在一般情况下，源程序有效注释量必须在 20% 以上。虽然注释有助于理解代码，但注意不可过多地使用注释。
规则一：注释是对代码的“提示”，而不是文档。程序中的注释不可喧宾夺主，注释太多会让人眼花缭乱。
规则二：如果代码本来就是清楚的，则不必加注释。
规则三：边写代码边注释，修改代码的同时要修改相应的注释，以保证注释与代码的一致性，不再有用的注释要删除。
规则四：当代码比较长，特别是有多重嵌套的时候，应当在段落的结束处加注释，这样便于阅读。
规则五：每一条宏定义的右边必须要有注释，说明其作用。
标签：注释,缩进,代码,运算符,空格,规则,源代码,优化 来源： https://www.cnblogs.com/silviayun/p/11657119.html
本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享； 2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关； 3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关； 4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除； 5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。