编程规范培训课件.ppt

1、C语言编程规范1、程序员花更多的时间在调试、维护和升级已有代码上，而不是编写新的代码；2、程序最重要的是正确性，其次是可维护性和效率；3、学习如何写优美的程序与学习如何正确地编写代码同样重要；4、让程序尽量简单易懂，不要使用复杂晦涩的语句；5、一个运行正常但没有注释的程序如同一个等待爆炸的定时炸弹，因为早晚会有人修改或升级这个程序；6、好风格应该成为一种习惯。如果你在开始写代码时就关心风格问题，如果你花时间去审视和改进它，你将会逐渐养成一种好的编程习惯。一旦这种习惯变成自动的东西，你的潜意识就会帮你照料许多细节问题，甚至你在工作压力下写出的代码也会更好。关于编程规范的几个原则关于编程规范的几个

2、原则 float b,c10;void abc(void)float zongfen=0;int d;for(d=0;d 0)zongfen+=cb;b=zongfen/10;这段程序在做什么？这段程序是否有错误？这程序中存在哪些不良的书写风格？它们可能会引起什么后果？程序实例程序实例float b,c10;void abc(void)float zongfen=0;int d;for(d=0;d 0)zongfen+=cb;b=zongfen/10;#define STUDENT_NUM 10 /学生总数float fAvgScore;/平均分float fScoreSTUDENT_NUM;

3、/分数/*平均分计算函数*/void AvgScore(void)int i;float total_score=0;/总分 for(i=0;i 0)/遇到负分,记为0分 total_score+=fScorei;/计算平均分 if(STUDENT_NUM 0)fAvgScore=total_score/STUDENT_NUM;有了哪些改进？你认为还有什么地方需要改进？1 排版 n程序块要采用缩进风格编写，缩进的空格数为4个。n相对独立的程序块之间、变量说明之后必须加空行。n较长的语句（80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的

4、缩进，使排版整齐，语句可读。1 排版 n程序块要采用缩进风格编写，缩进的空格数为4个。n相对独立的程序块之间、变量说明之后必须加空行。n较长的语句（80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。1 排版 nif、for、do、while、case、switch、default等语句自占一行，且if、for、do、while等语句的执行语句部分无论多少都要加括号。n对齐只使用空格键，不使用TAB键。n函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格，case语句下的情况处理语句也要遵从

5、语句缩进要求。1 排版 n程序块的分界符（如C/C+语言的大括号和）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。n在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如），后不应加空格。2 注释 n一般情况下，源程序有效注释量必须在20以上。n说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应进行注释，注释必须列出：版权说

6、明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。2 注释 n源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。n函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用关系（函数、表）等。n边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。2 注释 n注释的内容要清楚、明了，含义准确，防止注释二义性。n注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与

7、其上面的代码用空行隔开。n对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。2 注释 n数据结构声明(包括数组、结构、类、枚举等)，如果其命名不是充分自注释的，必须加以注释。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注释放在此域的右方。n全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。n注释与所描述内容进行同样的缩排。将注释与其上面的代码用空行隔开。2 注释 n避免在一行代码或表达式的中间插入注释。n通过对函数或过程、变

8、量、结构等正确的命名以及合理地组织代码的结构，使代码成为自注释的。n注释格式尽量统一，建议使用“/*/”。n注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，建议多使用中文，除非能用非常流利准确的英文表达。3 标识符命名 n标识符的命名要清晰、明了，有明确含义，同时使用完整的单词或大家基本可以理解的缩写，避免使人产生误解。n自己特有的命名风格，要自始至终保持一致，不可来回变化。命名中若使用特殊约定或缩写，则要有注释说明。n对于变量命名，禁止取单个字符（如i、j、k.），建议除了要有具体含义外，还能表明其变量类型、数据类型等，但i、j、k作局部循环变量是允许的。3 标识符命名 n命

9、名规范必须与所使用的系统风格保持一致，并在同一项目中统一，比如采用UNIX的全小写加下划线的风格或大小写混排的方式，不要使用大小写与下划线混排的方式，用作特殊标识如标识成员变量或全局变量的m_和g_，其后加上大小写混排的方式是允许的。n除非必要，不要用数字或较奇怪的字符来定义标识符。n除了编译开关/头文件等特殊应用，应避免使用_EXAMPLE_TEST_之类以下划线开始和结尾的定义。4 可读性 n注意运算符的优先级，并用括号明确表达式的操作顺序，避免使用默认优先级。n避免使用不易理解的数字，用有意义的标识来替代。涉及物理状态或者含有物理意义的常量，不应直接使用数字，必须用有意义的枚举或宏来代替

10、。n源程序中关系较为紧密的代码应尽可能相邻。不要使用难懂的技巧性很高的语句，除非很有必要时。5 变量、结构 n仔细定义并明确公共变量的含义、作用、取值范围及公共变量间的关系。去掉没必要的公共变量。明确公共变量与操作此公共变量的函数或过程的关系，如访问、修改及创建等。防止局部变量与公共变量同名。n严禁使用未经初始化的变量作为右值。n结构的功能要单一，是针对一种事务的抽象。不要设计面面俱到、非常灵活的数据结构。不同结构间的关系不要过于复杂。6 函数、过程 n对所调用函数的错误返回码要仔细、全面地处理。明确函数功能，精确（而不是近似）地实现函数设计。编写可重入函数时，应注意局部变量的使用。n编写可重入函数时，若使用全局变量，则应通过关中断、信号量（即P、V操作）等手段对其加以保护。n函数的规模尽量限制在200行以内。一个函数仅完成一件功能。为简单功能编写函数。不要设计多用途面面俱到的函数。6 函数、过程 n函数名应准确描述函数的功能。使用动宾词组为执行某操作的函数命名。如果是OOP方法。检查函数所有参数输入的有效性。检查函数所有非参数输入的有效性，如数据文件、公共变量等。n防止把没有关联的语句放到一个函数中。如果多段代码重复做同一件事情，那么在函数的划分上可能存在问题。设计高扇入、合理扇出（小于7）的函数。减少函数本身或函数间的递归调用。THE END