c语言编码规范

编码规范第一部分前言Preface为什么要这么做？书写良好的代码更容易阅读容易阅读的代码才容易被理解容易被理解的代码才健康编程风格体现了程序员对语言的理解水平求职：好的编程风格给别人良好的第一印象，是获得高薪的第一步1.编写目的通过编程规范的学习和强制执行，使同学们从一开始就接触基本的软件开发思想，了解基本的软件工程规范，养成良好的编程习惯；为后续课程的实践环节和日后实际工作打下良好的基础；也便于教师批改与回复电子作业。执行良好的编码规范可以使编写出来的程序易于阅读、理解和管理。2.编码规范的定义编码（coding）：是指用适当的代码编写工具编写C语言程序的源代码编码规范：相关英文说法：codingstandard,codingconvention,codingcriterion是指被普通采用的、或由某个企业或机构规定的，用计算机语言编写程序的过程中需要遵守的一套规则或约定的集合编码规范并不是语言的语法规则3.编码规范的应用在软件业高速发展、团队开发成为基本开发模式的今天，几乎每个软件企业或软件开发团队都会制定各种各样的规范，应用于软件开发过程的各个环节中，编码规范是最基础规范之一。不同的公司，对同一种开发语言，一般都采用类似的规范，也就是说编码规范具有一些通用性的标准4.编码规范的学习和执行要求学习和掌握规范标准要求在本课程的作业过程中执行这些规范，上交的电子作业必须符合这些规范要求要求在后续相关课程中执行此规范中的基本部分，并根据后续课程内容要求执行相应的扩展规范第二部分C语言编码规范Codingstandards1.文件级模块说明规范Filemodulespecification文件级模块说明规范的含义模块定义:指以独立的文件形式存在的模块，主要包括两类C或C++的扩展名为.c或.cpp的源代码文件模块，例如abc.cpp,exam.c扩展名为.h的头文件模块,如abc.h，exam.h对于任何一个用户新建的模块，必须按规范要求给出模块的相关描述信息文件级模块说明的构成文件级模块说明至少应由以下部分构成1.模块的作者信息2.模块的版权声明3.模块的名称4.模块的摘要描述5.模块的其它说明6.模块的历史信息文件级模块说明的编写1.每个用户的文件级代码模块必须编写一个说明2.模块说明要求以注释的形式出现在模块的首部3.为了减少每次的工作，每个人应先编写好不变部分，每新建一个模块将不变部分复制到文件首部，再行更改可变部分中文版文件级模块说明规范/****************************************************\作者信息：姓名：学号：班级：学院：Email:电话：版权声明：模块名称:本模块详细名称，不是文件名摘要:摘要地描述本模块的功能其它说明:可有可无，有关本模块的附加说明，这些说明可以在以后帮助代码的阅读者理解这个模块里的内容，如：算法的描述，特殊情况，参考资料等模块历史:谁于某年某月某日创建本模块，创建人email谁于某年某月某日修改本模块，修改人email修改原因：可有可无，根据需要添加\****************************************************/例子/****************************************************\作者信息：姓名：张三学号：06123456班级：计科0601班学院：计算机Email:[e-mail]电话：51689999版权声明：版权由张三所有，除老师外，未经允许不得拷贝本人作业模块名称:第一个模块摘要:本模块是我的第一个C语言作业，实现了一些简单的功能其它说明:无模块历史:张三于2006年9月20日创建本模块，email:[e-mail]张三于2006年9月25日修改本模块，email:同上修改原因：增加了一个输出正方形的函数\****************************************************/注意：红色部分为必填部分，缺填红色部分可能导致作业无法得到批阅注释开始注释结束/****************************************************\作者信息：姓名：张三学号：06123456班级：计科0601班学院：计算机Email:[e-mail]电话：51689999版权声明：版权由张三所有，除老师外，未经允许不得拷贝本人作业模块名称:第一个模块摘要:本模块是我的第一个C语言作业，实现了一些简单的功能其它说明:无模块历史:张三于2006年9月20日创建本模块，email:[e-mail]张三于2006年9月25日修改本模块，email:同上修改原因：增加了一个输出正方形的函数\****************************************************/#include“stdio.h”#include“string.h”/**********************\main函数说明\**********************/main(){…..}模块说明示例:example.cppEnglishVersion/****************************************************\AuthorInfo:Name:AuthorID:Class:School:Email:Tel.Copyright(c)2005NJTUModuleName:Anunabbreviatednameforthemodule(notthefilename)Abstract:DescriptionofwhatthismoduledoesNotes:[Optional]Additionalnotesaboutthismodule-thingsthatmayhelpthereaderofthiscodelateron.Examplesare:algorithmdescription,specialcaseconditions,references,etc.History:Createdonmm/dd/yyyybyemail-nameModifiedonmm/dd/yyyybyemail-name[Optional]historydescription\****************************************************/2.函数说明规范FunctionSpecification关于函数说明对于作业中程序的任何一个函数，包括main函数，都需要写出函数的说明一个良好的编程习惯：写任何一个函数以前，第一步工作就是先把函数说明写出来，而不是直接先写代码函数说明规范/***********************************************\函数名称:写出函数的名称功能描述:描述出函数具有的功能函数参数:输入输出参数说明，对每个参数都需要作出仔细说明返回值:返回值说明，或者标明无回值模块历史:谁于某年某月某日创建本模块，创建人email谁于某年某月某日修改本模块，修改人email修改原因：可有可无，根据需要添加\**********************************************/例子/**********************************************************************\函数名称:main功能描述:输出Helloworld!函数参数:无返回值:无模块历史:张三于2006年9月20日创建本模块，email:[e-mail]\*********************************************************************/voidmain(){printf(Helloworld!);}EnglishVersion/***********************************************\FunctionName:FunctionDescription:DescriptionofwhatthefunctiondoesArguments:[blank|OUT|IN/OUT]argument-name-descriptionofargument…ReturnValue:return-value-descriptionofreturnvalueorNONEHistory:Createdonmm/dd/yyyybyemail-name\**********************************************/3.代码注释恰到好处的注释1.对重要变量说明其作用；2.对每一段函数代码加注释说明功能；3.对重要的语句加注释说明其功能；4.对重要的函数调用的参数加实际参数说明；5.在自己认为必要的地方加上注释6.可以采用/**/和//进行注释4.基本编辑规范要求正确使用：缩进，空格，空行缩进根据语句间的层次关系采用缩进格式书写程序，每进一层，往后缩进一层函数内的变量声明与执行语句要缩进一层缩进长函数调用语句pMsg=ComReadMsgFromQueue(aServer,NULL,ComWait_c,lTimeOut);一个缩进层次为四个英文字符宽度一般用Tab键进行缩进，定义Tab为四个英文字符宽度许多开发工具编辑器如VC一般会自动帮你缩进要加空格的场合1.在逗号后面和语句中间的分号后面加空格，如：inti,j,k;for(i=0;in;i++)Result=func(a,b,c);2.在二目运算符的两边各留一个空格，如aba=bi=03.关键字两侧，如if()…,不要写成if()…4.类型与指针说明符之间一定要加空格：char*szName;不要加空格的场合1.在结构成员引用符号.和-左右两加不加空格：pStud-szName,Student.nID2.不要在行尾加多余的空格或Tab3.函数名与左括号之间不要加空格:func(…)4.指针说明符号*与变量名间不要加空格:int*pInt;不要写成:int*pInt;5.复合运算符中间不能加空格，否则会产生语法错误，如：a+=ba=b都是错误的空行与换行1.函数的变量说明与执行语句之间加上空行;2.每个函数内的主要功能块之间加空行表示区隔;3.一行语句不要写的太长，将长语句分成多行写;4.不要在一行中写多条语句.例子intmain(){inti,j,nSum=0;//变量说明for(i=0;i10;i++)//执行代码{for(j=0;j10;j++){nSum+=i;}}}注意空格空行注意各层缩进5.标识符命名NamingIndentifiers标识符命名基本要求1.这里所指的标识符包括符号常量、变量、函数名、类型名、成员名、C++中的类名等需要编程者命名的各种文字符号2.标识符命名必须符合语法规则3.任何标识符的命名最好能有一定的含义4.标识符的命名尽量采用英文5.1符号常量命名规范符号常量的命名用大写字母表示如#defineLENGTH10如果符号常量由多个单词构成，两个不同的单词之间可以用下划线连接如#defineMAX_LEN505.2变量命名普通规范1.变量名一般需要反映变量的用途如:intsum;2.如果变量名由多个单词构成，每个单词的首字符要大写如:intTotalFiles;5.3变量命名与变量类型在实际软件开发中，常见的规范强制要求能从变量名中看出变量的类型，因此，建议同学们一开始就养成这样的习惯。使变量能反映类型的方法是在变量的前面