优质文档语c常见规则优秀word范文 25页.docx
- 文档编号:852080
- 上传时间:2022-10-13
- 格式:DOCX
- 页数:20
- 大小:27.21KB
优质文档语c常见规则优秀word范文 25页.docx
《优质文档语c常见规则优秀word范文 25页.docx》由会员分享,可在线阅读,更多相关《优质文档语c常见规则优秀word范文 25页.docx(20页珍藏版)》请在冰豆网上搜索。
优质文档语c常见规则优秀word范文25页
本文部分内容来自网络整理,本司不为其真实性负责,如有异议或侵权请及时联系,本司将立即删除!
==本文为word格式,下载后可方便编辑和修改!
==
语c常见规则
篇一:
C语言常用规则
C语言常用规则
一、程序风格:
1、严格采用阶梯层次组织程序代码:
各层次缩进的分格采用VC的缺省风格,即每层次缩进为4格,括号位于下一行。
要求相匹配的大括号在同一列,对继行则要求再缩进4格。
例如:
2、提示信息字符串的位置
在程序中需要给出的提示字符串,为了支持多种语言的开发,除了一些给调试用的临时信息外,其他所有的提示信息必须定义在资源中。
3、对变量的定义,尽量位于函数的开始位置。
这样的目的是为了检查的方便,以后自己看或检查和别人看会方便很多,具体的资料还可以参考林锐写的关于C语言的一个文章!
二、命名规则:
1、变量名的命名规则
①、变量的命名规则要求用“匈牙利法则”。
即开头字母用变量的类型,其余部分用变量的英文意思或其英文意思的缩写,尽量避免用中文的拼音,要求单词的第一个字母应大写。
即:
变量名=变量类型+变量的英文意思(或缩写)对非通用的变量,在定义时加入注释说明,变量定义尽量可能放在函数的开始处。
见下表:
对未给出的变量类型要求提出并给出命名建议给技术委员会。
②、指针变量命名的基本原则为:
对一重指针变量的基本原则为:
“p”+变量类型前缀+命名
如一个float*型应该表示为pfStat对多重指针变量的基本规则为:
二重指针:
“pp”+变量类型前缀+命名三重指针:
“ppp”+变量类型前缀+命名......
③、全局变量用g_开头,如一个全局的长型变量定义为g_lFailCount,即:
变量名=g_+变量类型+变量的英文意思(或缩写)
④、静态变量用s_开头,如一个静态的指针变量定义为s_plPerv_Inst,即:
变量名=s_+变量类型+变量的英文意思(或缩写)
⑤、成员变量用m_开头,如一个长型成员变量定义为m_lCount;即:
变量名=m_+变量类型+变量的英文意思(或缩写)
⑥、对枚举类型(enum)中的变量,要求用枚举变量或其缩写做前缀。
并且要求用大写。
如:
enumcmEMDAYS{
EMDAYS_MONDAY;EMDAYS_TUESDAY;
?
?
};
⑦、对struct、union、class变量的命名要求定义的类型用大写。
并要加上前缀,其内部变量的命名规则与变量命名规则一致。
结构一般用S开头
如:
structScmNPoint{
intnX;//点的X位置
intnY;//点的Y位置};
联合体一般用U开头
如:
unionUcmLPoint{
longlX;longlY;}
类一般用C开头如:
classCcmFPoint{
public:
floatfPoint;};
对一般的结构应该定义为类模板,为以后的扩展性考虑如:
template
classCcmTVector3d{
public:
TYPEx,y,z;};
⑧、对常量(包括错误的编码)命名,要求常量名用大写,常量名用英文表达其意思。
如:
#defineCM_FILE_NOT_FOUNDCMMAKEHR(0X20B)其中CM表示类别。
⑨、对const的变量要求在变量的命名规则前加入c_,即:
c_+变量命名规则;例如:
constchar*c_szFileName;2、函数的命名规范:
函数的命名应该尽量用英文表达出函数完成的功能。
遵循动宾结构的命名法则,函数名中动词在前,并在命名前加入函数的前缀,函数名的长度不得少于8个字母。
例如:
longcmGetDeviceCount(?
?
);
3、函数参数规范:
①、参数名称的命名参照变量命名规范。
②、为了提高程序的运行效率,减少参数占用的堆栈,传递大结构的参数,一律采用指针或引用方式传递。
③、为了便于其他程序员识别某个指针参数是入口参数还是出口参数,同时便于编译器检查错误,应该在入口参数前加入const标志。
如:
?
?
cmCopyString(constchar*c_szSource,char*szDest)
4、引出函数规范:
对于从动态库引出作为二次开发函数公开的函数,为了能与其他函数以及Windows的函数区分,采用类别前缀+基本命名规则的方法命名。
例如:
在对动态库中引出的一个图象编辑的函数定义为imgFunctionname(其中img为image缩写)。
现给出三种库的命名前缀:
①、对通用函数库,采用cm为前缀。
②、对三维函数库,采用vr为前缀。
③、对图象函数库,采用img为前缀。
对宏定义,结果代码用同样的前缀。
5、文件名(包括动态库、组件、控件、工程文件等)的命名规范:
文件名的命名要求表达出文件的内容,要求文件名的长度不得少于5个字母,严禁使用象file1,myfile之类的文件名。
三、注释规范:
1、函数头的注释
对于函数,应该从“功能”,“参数”,“返回值”、“主要思路”、“调用方法”、“日期”六个方面用如下格式注释:
//程序说明开始
//================================================================//
//功能:
从一个String中删除另一个String。
//参数:
strByDelete,strToDelete
//(入口)strByDelete:
被删除的字符串(原来的字符串)
//(出口)strToDelete:
要从上个字符串中删除的字符串。
//返回:
找到并删除返回1,否则返回0。
(对返回值有错误编码的要//求列出错误编码)。
//主要思路:
本算法主要采用循环比较的方法来从strByDelete中找到
//与strToDelete相匹配的字符串,对多匹配strByDelete//中有多个strToDelete子串)的情况没有处理。
请参阅:
//书名......
//调用方法:
......
//日期:
起始日期,如:
201X/8/21.9:
40--201X/8/23.21:
45
//================================================================//
函数名(?
?
)//程序说明结束
①、对于某些函数,其部分参数为传入值,而部分参数为传出值,所以对参数要详细说明该参数是入口参数,还是出口参数,对于某些意义不明确的参数还要做详细说明(例如:
以角度作为参数时,要说明该角度参数是以弧度(PI),还是以度为单位),对既是入口又是出口的变量应该在入口和出口处同时标明。
等等。
②、函数的注释应该放置在函数的头文件中,在实现文件中的该函数的实现部分应该同时放置该注释。
③、在注释中应该详细说明函数的主要实现思路、特别要注明自己的一些想法,如果有必要则应该写明对想法产生的来由。
对一些模仿的函数应该注释上函数的出处。
④、在注释中详细注明函数的适当调用方法,对于返回值的处理方法等。
在注释中要强调调用时的危险方面,可能出错的地方。
⑤、对日期的注释要求记录从开始写函数到结束函数的测试之间的日期。
⑥、对函数注释开始到函数命名之间应该有一组用来标识的特殊字符串。
如果算法比较复杂,或算法中的变量定义与位置有关,则要求对变量的定义进行图解。
对难以理解的算法能图解尽量图解。
2、变量的注释:
对于变量的注释紧跟在变量的后面说明变量的作用。
原则上对于每个变量应该注释,但对于意义非常明显的变量,如:
i,j等循环变量可以不注释。
例如:
longlLineCount//线的根数。
3、文件的注释:
文件应该在文件开头加入以下注释:
/////////////////////////////////////////////////////////////////////
//工程:
文件所在的项目名。
//作者:
**,修改者:
**//描述:
说明文件的功能。
//主要函数:
?
?
?
?
//版本:
说明文件的版本,完成日期。
//修改:
说明对文件的修改内容、修改原因以及修改日期。
//参考文献:
......
/////////////////////////////////////////////////////////////////////
为了头文件被重复包含要求对头文件进行定义如下:
#ifndef__FILENAME_H__#define__FILENAME_H__其中FILENAME为头文件的名字。
4、其他注释:
篇二:
C语言常见命名规则
C语言常见命名规则
一、概述
比较著名的命名规则首推匈牙利命名法,这种命名方法是由Microsoft程序员查尔斯·西蒙尼(CharlesSimonyi)提出的。
其主要思想是“在变量和函数名中加入前缀以增进人们对程序的理解”。
匈牙利命名法关键是:
标识符的名字以一个或者多个小写字母开头作为前缀;前缀之后的是首字母大写的一个单词或多个单词组合,该单词要指明变量的用途。
[例如]lpszStr,表示指向一个以'\0'结尾的字符串(sz)的长指针(lp)变量。
骆驼(Camel)命名法近年来越来越流行,在许多新的函数库和Java这样的平台下使用得当相多。
骆驼命名法,正如它的名称所表示的那样,指的是混合使用大小写字母来构成标识符的名字。
其中第一个单词首字母小写,余下的单词首字母大写。
[例如]printEmployeePaychecks(),函数名中每一个逻辑断点都有一个大写字母来标记。
帕斯卡(Pascal)命名法与骆驼命名法类似。
只不过骆驼命名法是第一个单词首字母小写,而帕斯卡命名法则是第一个单词首字母大写。
[例如]DisplayInfo()和UserName都是采用了帕斯卡命名法。
在C#中,以帕斯卡命名法和骆驼命名法居多。
事实上,很多程序设计者在实际命名时会将骆驼命名法和帕斯卡结合使用,例如变量名采用骆驼命名法,而函数采用帕斯卡命名法。
另一种流行的命名规则称为下划线命名法。
下划线法是随着C语言的出现流行起来的,在UNIX/LIUNX这样的环境,以及GNU代码中使用非常普遍。
1、常量名用大写,太长时用下划线隔开:
1.#defineMAX
2.#defineINCREMENT_SIZE
2、变量名采用小驼峰形式书写:
1.intfirst
2.floatnewElem
3、函数名、结构名和联合名采用大驼峰形式书写:
1.voidClearList(List*L)
2.{
3.….
4.}
5.intPutElem(intelem)
6.{
7.….
8.}
9.typedefstructLinkNode
10.{
11.intdata;
12.structLinkNode*next;
13.}*LinkPoint;
4、全局变量加前缀“g_”,其余特殊变量类似
本章所述的命名规则主要基于下划线命名法发展而来。
单字符的名字也是常用的,如i,j,k等,它们通常可用作函数内的局部变量。
tmp常用做临时变量名。
局部静态变量,应加s_词冠(表示static),如:
staticints_lastw;
全局变量(尤其是供外部访问的全局变量),应加g_词冠(表示global),如:
void(*g_capture_hook)(void);
二、各类命名规则
1.函数的命名
函数名使用下划线分割小写字母的方式命名:
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 优质文档语c常见规则优秀word范文 25页 优质 文档 常见 规则 优秀 word 范文 25