C语言的规范(非常经典)

C语言的规范(非常经典)
C语言的规范(非常经典)

C语言的规范

C语言的规范2007-11-03 08:20A.1 排版

1-1:程序块要采用缩进风格编写,缩进的TAB键一个。

1-2:相对独立的程序块之间、变量说明之后必须加空行。

1-3:较长的语句(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。

1-4:循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首。

1-5:若函数或过程中的参数较长,则要进行适当的划分。

1-6:不允许把多个短语句写在一行中,即一行只写一条语句。

1-7:if、while、for、default、do等语句自占一行。

1-8:对齐只使用TAB键,不使用空格键。

1-9:函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,ca se语句下的情况处理语句也要遵从语句缩进要求。

1- 10:程序块的分界符(如C/C++语言的大括号'{'和'}')应各独占一行并且位于同一列,同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while0、switch、case语句中的程序都要采用如上的缩进方式。

1-11:在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如->),后不应加空格。

1-12: 程序结构清析,简单易懂,单个函数的程序行数不得超过100行。

A.2 注释

2-1:一般情况下,源程序有效注释量必须在20%以上。

2-2:说明性文件(如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。

2-3:源文件头部应进行注释,列出:版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。

2-4:函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。

2-5:边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。

2-6:注释的内容要清楚、明了,含义准确,防止注释二义性。

2-7:避免在注释中使用缩写,特别是非常用缩写。

2-8:注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。

2-9:对于所有有物理含义的变量、常量,如果其命名不是充分自注释的,在声明时都必须加以注释,说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。

2-10:数据结构声明(包括数组、结构、类、枚举等),如果其命名不是充分自注释的,必须加以注释。对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释放在此域的右方。

2-11:全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。

2-12:注释与所描述内容进行同样的缩排。

2-13:将注释与其上面的代码用空行隔开。

2-14:对变量的定义和分支语句(条件分支、循环语句等)必须编写注释。

2-15:对于switch语句下的case语句,如果因为特殊情况需要处理完一个case后进入下一个case处理,必须在该case语句处理完、下一个case语句前加上明确的注释。

A.3 标识符命名

3-1:标识符的命名要清晰、明了,有明确含义,同时使用完整的单词或大家基本可以理解的缩写,避免使人产生误解。

3-2:命名中若使用特殊约定或缩写,则要有注释说明。

3-3:自己特有的命名风格,要自始至终保持一致,不可来回变化。

3-4:对于变量命名,禁止取单个字符(如i、j、k...),建议除了要有具体含义外,还能表明其变量类型、数据类型等,但i、j、k作局部循环变量是允许的。

3-5:命名规范必须与所使用的系统风格保持一致,并在同一项目中统一,比如采用UNIX 的全小写加下划线的风格或大小写混排的方式,不要使用大小写与下划线混排的方式。A.4 可读性

4-1:注意运算符的优先级,并用括号明确表达式的操作顺序,避免使用默认优先级。

4-2:避免使用不易理解的数字,用有意义的标识来替代。涉及物理状态或者含有物理意义的常量,不应直接使用数字,必须用有意义的枚举或宏来代替。

A.5 变量

5-1:去掉没必要的公共变量。

5-2:仔细定义并明确公共变量的含义、作用、取值范围及公共变量间的关系。

5-3:明确公共变量与操作此公共变量的函数或过程的关系,如访问、修改及创建等。

5-4:当向公共变量传递数据时,要十分小心,防止赋与不合理的值或越界等现象发生。

5-5:防止局部变量与公共变量同名。

5-6:严禁使用未经初始化的变量作为右值。

A.6 函数、过程

6-1:对所调用函数的错误返回码要仔细、全面地处理。

6-2:明确函数功能,精确(而不是近似)地实现函数设计。

6-3:编写可重入函数时,应注意局部变量的使用(如编写C/C++语言的可重入函数时,应使用auto即缺省态局部变量或寄存器变量)。

6-4:编写可重入函数时,若使用全局变量,则应通过关中断、信号量(即P、V操作)等手段对其加以保护。

A.7 可测性

7-1:在同一项目组或产品组内,要有一套统一的为集成测试与系统联调准备的调测开关及相应打印函数,并且要有详细的说明。

7-2:在同一项目组或产品组内,调测打印出的信息串的格式要有统一的形式。信息串中至少要有所在模块名(或源文件名)及行号。

7-3:编程的同时要为单元测试选择恰当的测试点,并仔细构造测试代码、测试用例,同时给出明确的注释说明。测试代码部分应作为(模块中的)一个子模块,以方便测试代码在模块中的安装与拆卸(通过调测开关)。

7-4:在进行集成测试/系统联调之前,要构造好测试环境、测试项目及测试用例,同时仔细分析并优化测试用例,以提高测试效率。

7-5:使用断言来发现软件问题,提高代码可测性。

7-6:用断言来检查程序正常运行时不应发生但在调测时有可能发生的非法情况。

7-7:不能用断言来检查最终产品肯定会出现且必须处理的错误情况。

7-8:对较复杂的断言加上明确的注释。

7-9:用断言确认函数的参数。

7-10:用断言保证没有定义的特性或功能不被使用。

7-11:用断言对程序开发环境(OS/Compiler/Hardware)的假设进行检查。

7-12:正式软件产品中应把断言及其它调测代码去掉(即把有关的调测开关关掉)。

7-13:在软件系统中设置与取消有关测试手段,不能对软件实现的功能等产生影响。

7-14:用调测开关来切换软件的DEBUG版和正式版,而不要同时存在正式版本和DEBUG 版本的不同源文件,以减少维护的难度。

7-15:软件的DEBUG版本和发行版本应该统一维护,不允许分家,并且要时刻注意保证两个版本在实现功能上的一致性。

A.8 程序效率

8-1:编程时要经常注意代码的效率。

8-2:在保证软件系统的正确性、稳定性、可读性及可测性的前提下,提高代码效率。

8-3:局部效率应为全局效率服务,不能因为提高局部效率而对全局效率造成影响。

8-4:通过对系统数据结构的划分与组织的改进,以及对程序算法的优化来提高空间效率。8-5:循环体内工作量最小化。

A.9 质量保证

9-1:在软件设计过程中构筑软件质量。

9-2:代码质量保证优先原则

9-3:只引用属于自己的存贮空间。

9-4:防止引用已经释放的内存空间。

9-5:过程/函数中分配的内存,在过程/函数退出之前要释放。

9-6:过程/函数中申请的(为打开文件而使用的)文件句柄,在过程/函数退出之前要关闭。9-7:防止内存操作越界。

9-8:认真处理程序所能遇到的各种出错情况。

9-9:系统运行之初,要初始化有关变量及运行环境,防止未经初始化的变量被引用。

9-10:系统运行之初,要对加载到系统中的数据进行一致性检查。

9-11:严禁随意更改其它模块或系统的有关设置和配置。

9-12:不能随意改变与其它模块的接口。

9-13:充分了解系统的接口之后,再使用系统提供的功能。

9-14:编程时,要防止差1错误。

9-15:要时刻注意易混淆的操作符。当编完程序后,应从头至尾检查一遍这些操作符,以防止拼写错误。

9-16:有可能的话,if语句尽量加上else分支,对没有else分支的语句要小心对待;switc h语句必须有default分支。

9-17:禁止GOTO语句。

9-18:单元测试也是编程的一部份,提交联调测试的程序必须通过单元测试。

A.10 代码编辑、编译、审查

10-1:打开编译器的所有告警开关对程序进行编译。

10-2:在产品软件(项目组)中,要统一编译开关选项。

10-3:通过代码走读及审查方式对代码进行检查。

A.11 代码测试、维护

11-1:单元测试要求至少达到语句覆盖。

11-2:单元测试开始要跟踪每一条语句,并观察数据流及变量的变化。11-3:清理、整理或优化后的代码要经过审查及测试。

11-4:代码版本升级要经过严格测试。

11-5:使用工具软件对代码版本进行维护。

11-6:正式版本上软件的任何修改都应有详细的文档记录。

A.12 宏

12-1:用宏定义表达式时,要使用完备的括号。

12-2:将宏所定义的多条表达式放在大括号中。

12-3:使用宏时,不允许参数发生变化

C语言考试重点(考前必看,吃透必过)

C语言最重要的知识点 总体上必须清楚的: 1)程序结构是三种: 顺序结构、选择结构(分支结构)、循环结构。 2)读程序都要从main()入口, 然后从最上面顺序往下读(碰到循环做循环,碰到选择做选择),有且只有一个main函数。 3)计算机的数据在电脑中保存是以二进制的形式. 数据存放的位置就是他的地址. 4)bit是位是指为0 或者1。 byte是指字节, 一个字节 = 八个位. 概念常考到的: 1、编译预处理不是C语言的一部分,不占运行时间,不要加分号。C语言编译的程序称为源程序,它以ASCII数值存放在文本文件中。 2、define PI 3.1415926; 这个写法是错误的,一定不能出现分号。 3、每个C语言程序中main函数是有且只有一个。 4、在函数中不可以再定义函数。 5、算法:可以没有输入,但是一定要有输出。 6、break可用于循环结构和switch语句。 7、逗号运算符的级别最低,赋值的级别倒数第二。 第一章C语言的基础知识 第一节、对C语言的基础认识 1、C语言编写的程序称为源程序,又称为编译单位。 2、C语言书写格式是自由的,每行可以写多个语句,可以写多行。 3、一个C语言程序有且只有一个main函数,是程序运行的起点。 第二节、熟悉vc++ 1、VC是软件,用来运行写的C语言程序。 2、每个C语言程序写完后,都是先编译,后链接,最后运行。(.c---→.obj---→.exe)这个过程中注意.c和.obj文件时无法运行的,只有.exe 文件才可以运行。(常考!) 第三节、标识符 1、标识符(必考内容): 合法的要求是由字母,数字,下划线组成。有其它元素就错了。 并且第一个必须为字母或则是下划线。第一个为数字就错了 2、标识符分为关键字、预定义标识符、用户标识符。 关键字:不可以作为用户标识符号。main define scanf printf 都不是关键字。迷惑你的地方If是可以做为用户标识符。因为If中的第一个字母大写了,所以不是关键字。 预定义标识符:背诵define scanf printf include。记住预定义标识符可以做为用户标识符。

C_C++变量命名规则

C/C++变量命名规则 变量命名规则是为了增强代码的可读性和容易维护性。以下为C++必须遵守的变量命名规则: 1、变量名只能是字母(A-Z,a-z)和数字(0-9)或者下划线(_)组成。 2、第一个字母必须是字母或者下划线开头。 3、不能使用C++关键字来命名变量,以免冲突。 4、变量名区分大小写。 变量命名规则: 一、用最短字符表示最准确的意义。 二、使用变量前缀。 1、整型前缀 int nId; //int前缀:n short sId; //short前缀:s unsigned int unId // unsigned int 前缀:un long lId; //long前缀:l 2、浮点型前缀 float fValue; //float前缀:f double dValue; //double前缀:d 3、字符型前缀 char chChar; //char前缀:ch 4、字符串前缀 char szPath; //char字符串前缀:sz string strPath; //string字符串前缀:str CString strPath; //MFC CString类前缀:str 5、布尔型前缀 bool bIsOK; //bool类型前缀:b BOOL bIsOK; //MFC BOOL前缀:b 6、指针型前缀 char * pPath; //指针前缀:p 7、数组前缀 int arrnNum; //数组前缀:arr CString arrstrName; //数组前缀+类型前缀+名称

8、结构体前缀 STUDENT tXiaoZhang; //结构体前缀:t 9、枚举前缀 enum emWeek; //枚举前缀:em 10、字节的前缀 BYTE byIP; //字节前缀:by 11、字的前缀 DWORD dwMsgID; //双字前缀:dw WORD wMsgID; //单字前缀:w 12、字符指针前缀 LPCTSTR ptszName; //TCHAR类型为ptsz LPCSTR pszName; //pcsz LPSTR pszName; //psz 13、STL容器前缀 vector vecValue; //vector容器前缀:vec 14、RECT矩形结构前缀 RECT rcChild; //rc CRECT rcChild/ //rc 15、句柄前缀 HWND hWndDlg; //h HBRUSH hBr; //h HPEN hPen; //h HBITMAP hBmpBack; //h 16、Windows颜色前缀 COLORREF crFont; //cr 17、Windows DC前缀 CDC dcClient; //dc 三、类的成员变量以m_开头,后面为变量,变量同时还要加前缀。 CString m_strName; //m_开头+类型前缀+名称 四、定义一个变量,为了简化,在不影响变量意义的情况下,可仅仅使用前缀。 RECT rc; 五、全局变量一律以g_开头,后面为变量,变量同时还要加前缀。

C语言格式书写规范

C语言书写规范指南 第1章文件结构 每个C程序通常分为两个文件。一个文件用于保存程序的声明(declaration),称为头文件。另一个文件用于保存程序的实现(implementation),称为定义(definition)文件。 C程序的头文件以“、h”为后缀,C程序的定义文件以“、c”为后缀。 1、1版权与版本的声明 版权与版本的声明位于头文件与定义文件的开头(参见示例1-1),主要内容有: (1)版权信息。 (2)文件名称,标识符,摘要。 (3)当前版本号,作者/修改者,完成日期。 (4)版本历史信息。 /* *Copyright(c)2001,吉林大学物理学院无线电 *Allrightsreserved、 * *文件名称: *文件标识: *摘要:简要描述本文件的内容 * *当前版本:1、1 *作者:输入作者(或修改者)名字 *完成日期:2007年7月20日 * *取代版本:1、0 *原作者:输入原作者(或修改者)名字 *完成日期:2007年5月10日 */ 示例1-1版权与版本的声明

1、2头文件的结构 头文件由三部分内容组成: (1)头文件开头处的版权与版本声明(参见示例1-1)。 (2)预处理块。 (3)函数与类结构声明等。 假设头文件名称为SCL_SPI、h,头文件的结构参见示例1-2。 【规则1-2-1】为了防止头文件被重复引用,应当用#ifndef/#define/#endif结构产生预处理块。 【规则1-2-2】用#include <>格式来引用标准库的头文件(编译器将从标准库目录开始搜索)。 【规则1-2-3】用#include “”格式来引用非标准库的头文件(编译器将从用户的工作目录开始搜索)。 【规则1-2-4】#include 后面使用TAB键控制排版。 【规则1-2-5】头文件中只存放“声明”而不存放“定义” 【规则1-2-6】全局变量在头文件中声明,在、c文件中定义 、h extern in tvalue; 声明。 、c in tvalue=0x10; 定义。 【规则1-2-7】局部变量在、c中定义(static)unsigned in tvalue; 定义。 //版权与版本声明见示例1-1,此处省略。 #ifndef SCL_SPI_H //防止SCL_SPI、h被重复引用 #define SCL_SPI_H #include //引用标准库的头文件 … #include “SCL_CAN、h” //引用非标准库的头文件 … void Function1(…);//全局函数声明 … extern unsign int value;//全局变量声明 #endif 示例1-2C头文件的结构 1、3定义文件的结构 定义文件有三部分内容: (1)定义文件开头处的版权与版本声明(参见示例1-1)。 (2)对一些头文件的引用。 (3)程序的实现体(包括数据与代码)。

单片机C语言变量名命名规则整理

C语言变量名命名规则 一、程序风格: 1、严格采用阶梯层次组织程序代码: 各层次缩进的分格采用VC的缺省风格,即每层次缩进为4格,括号位于下一行。 要求相匹配的大括号在同一列,对继行则要求再缩进4格。例如: 2、提示信息字符串的位置 在程序中需要给出的提示字符串,为了支持多种语言的开发,除了一些给调试用的临时信息外,其他所有的提示信息必须定义在资源中。 3、对变量的定义,尽量位于函数的开始位置。 二、命名规则: 1、变量名的命名规则 ①、变量的命名规则要求用“匈牙利法则”。即开头字母用变量的类型,其余部分用变量的英文意思或其英文意思的缩写,尽量避免用中文的拼音,要求单词的第一个字母应大写。 即:变量名=变量类型+变量的英文意思(或缩写) 对非通用的变量,在定义时加入注释说明,变量定义尽量可能放在函数的开始处。 见下表:

对未给出的变量类型要求提出并给出命名建议给技术委员会。 ②、指针变量命名的基本原则为: 对一重指针变量的基本原则为: “p”+变量类型前缀+命名 如一个float*型应该表示为pfStat 对多重指针变量的基本规则为: 二重指针:“pp”+变量类型前缀+命名 三重指针:“ppp”+变量类型前缀+命名 ...... ③、全局变量用g_开头,如一个全局的长型变量定义为g_lFailCount,即:变量名=g_+变量类型+变量的英文意思(或缩写) ④、静态变量用s_开头,如一个静态的指针变量定义为s_plPerv_Inst,即:变量名=s_+变量类型+变量的英文意思(或缩写) ⑤、成员变量用m_开头,如一个长型成员变量定义为m_lCount;即:变量名=m_+变量类型+变量的英文意思(或缩写) ⑥、对枚举类型(enum)中的变量,要求用枚举变量或其缩写做前缀。并且要求用大写。 如:enum cmEMDAYS { EMDAYS_MONDAY; EMDAYS_TUESDAY; …… }; ⑦、对struct、union、class变量的命名要求定义的类型用大写。并要加

C语言编写规范之注释

1、头文件包含Includes 2、私有类型定义 Private typedef 3、私有定义Private define 4、私有宏定义 Private macro 5、私有变量 Private variables 6、私有函数原型Private function prototypes 7、私有函数Private functions 8、私有函数前注释 /****************************************************************************** * * Function Name : FSMC_NOR_Init * Description : Configures the FSMC and GPIOs to interface with the NOR memory. * This function must be called before any write/read operation * on the NOR. * Input : None * Output : None * Return : None ******************************************************************************* / 9、程序块采用缩进风格编写,缩进空格为4。 10、相对独立的程序块之间、变量说明之后必须加空行; 11、较长的字符(>80字符)要分成多行书写,长表达式要在低优先级操作符划分新行,操作符放在新行之首,新行要恰当缩进,保持排版整齐; 12、循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首; 13、若函数或过程中的参数较长,则要进行适当的划分。 14、不允许把多个短语句写在一行中,即一行只写一条语句。 15、if、for、do、while、case、switch、default等语句自占一行,且if、for、 do、while等语句的执行语句部分无论多少都要加括号{}。 16、对齐只使用空格键,不使用TAB键; 17、 函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,case 语句下的情况处理语句也要遵从语句缩进要求 18、 程序块的分界符(如C/C++语言的大括号‘{’和‘}’)应各独占一行并且位于同一 列,同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以 及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。 19、 在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或

书写C语言程序的注意事项

书写C语言程序的注意事项 1、每一C程序必须有一个main( ),且也只能有一个main( ),程序始终是从main的第一个’{‘开 始执行的;如果遇到调用函数,流程就转向对应的被调用函数,执行被调用函数中的相应语句,直到遇到return语句或‘}’时,流程又返回到主调函数中的调用处,继续执行其后的后续语句,直到遇到主函数main( )后的最后一个‘}’为止,此时结束整个程序; 2、分号是C语句的结束符,而不是分隔符,除以下情形不用分号外,其余情形都必须用分号: 1)绝对不能用分号 a)命令行后不用,即程序最开头的#include “”和#define …… b)main( )后不用; c)子函数的函数首项后不用; d)‘{’后不用; e)‘}’后不用;但是在结构体、共用体、枚举类型后的‘}’后必须用;

f)switch( )后不用; g)case常量后不用; h)default后不用; 2)可用可不用分号的情形,用了虽然没有语法错误,但是一般达不到程序设计的目的。 i)if( )后 j)else后 k)while( )后 l)for( )后 3、C语言允许有注释语句,一旦被注释起来的语句,程序是不会执行的,其注释格式为: a)/*注释内容*/:可以放于一行进行注释,也可以C语句的行末进行注释,还可以将几行一起进行注释; b)//注释内容:只能注释一行 4、C语句中的格式符是以%开头,其后紧跟一个格式说明符,如: int:%d

char:%c float:%f long:%ld unsigned:%u; double:%f,%e,%lf,%le; 八进制数:%o 十六进制数:%x; 如果要在屏幕上输出一个%,则必须用两个%来输出; 5、C程序中用到的所有变量,都必须“先定义,后使用”,且“先有值,后运算”; 6、scanf( )和printf( )中的双引号中的格式符必须从左到右与其后的输入项、输出项类型匹配、个 数相等。 7、scanf( )中的输入项前应该跟地址符&,而格式符%s对应的输入项除外; 如:int a,b;

C语言书写规范

1.C语言书写规范 1.1符号命名规则 1.1.1符号名包括模块名、常量名、标号名、子程序名等。这些名字应该能反映它所代表的实际东西,具有一定的意义,使其能够见名知义,有助于对程序功能的理解。命名采用匈牙利命名法。规则如下: (1)所有宏定义、枚举常数和const变量,用大写字母命名。在复合词里用下划线隔开每个词。 (2)复合词中每个单词的第一个字母大写。除了规则5.1.1.1以外,避免使用下划线。 (3)类、类型定义和枚举型名的第一个字母大写。 (4)函数名是复合词的,第一个词采用全部小写,随后每个单词采用第一个字母大写,其它字母小写方式;如果是单个词的,采用全部小写方式。 (5)循环变量可采用i, j, k等,不受上述规则限制。 (6) 类的成员变量应采用m_开头。 (7) 全局变量词头为g_ 。 (8) 临时变量词头为tmp_ 。 (9) 对结构体内的变量命名, 遵循变量的具体含义命名原则 (10)用小写字母的前缀表示变量的类型,前缀的下一个字母用大写。 表1 词头类型词头类型 ch char l long i integer u unsigned b boolean p pointer f float lp lon g pointer d doubl e s string st structure sz ASCII string by byte n short int H handle x,y 分别为x,y坐标

dw DWORD fn function 表2 词头变量名词头变量名 task task sig signal sb binary semaphores wd watchdog sm mutual exclusion semaphores tm timer sc counting semaphores msg message pipe pipe 例: #define ARRAY_SIZE 24 /*规则5.1.1.1*/ int g_iFlag; class MyClass /*规则5.1.1.3*/ { }; void someFunc( ) /*规则5.1.1.2和5.1.1.4*/ { .2. Q/ECC/BJ 010—2001 int nArray[ARRAY_SIZE]; unsigned char uchByte; char szName[ ]; char *pszName = szName; }

C基本书写规范

C#书写规范 一、命名 对于理解应用程序的逻辑流,命名方案是最有影响力的一种帮助。名称应该说明“什么”而不是“如何”。通过避免使用公开基础实现(它们会发生改变)的名称,可以保留简化复杂性的抽象层。例如,可以使用GetNextStudent(),而不是GetNextArrayElement()。 命名原则是: 选择正确名称时的困难可能表明需要进一步分析或定义项的目的。使名称足够长以便有一定的意义,并且足够短以避免冗长。唯一名称在编程上仅用于将各项区分开。表现力强的名称是为了帮助人们阅读;因此,提供人们可以理解的名称是有意义的。不过,请确保选择的名称符合适用语言的规则和标准。 以下几点是推荐的命名方法。 1、方法、属性、变量规范 ?避免容易被主观解释的难懂的名称,如方面名AnalyzeThis(),或者属性名xxK8。这样的名称会导致多义性。 ?在面向对象的语言中,在类属性的名称中包含类名是多余的,如Book.BookTitle。而是应该使用Book.Title。 ?使用动词-名词的方法来命名对给定对象执行特定操作的例程,如CalculateInvoiceTotal()。 ?在允许函数重载的语言中,所有重载都应该执行相似的函数。 ?只要合适,在变量名的末尾或开头加计算限定符(Avg、Sum、Min、Max、Index)。 ?在变量名中使用互补对,如min/max、begin/end 和open/close。 ?鉴于大多数名称都是通过连接若干单词构造的,请使用大小写混合的格式以简化它们的阅读。另外,为了帮助区分变量和例程,请对例程名称使用Pascal 大小写处理(CalculateInvoiceTotal),其中每个单词的第一个字母都是大写的。对于变量名,请使用camel 大小写处理(documentFormatType),其中除了第一个单词外每个单词的第一个字母都是大写的。 ?布尔变量名应该包含Is,这意味着Yes/No 或True/False 值,如fileIsFound。 ?在命名状态变量时,避免使用诸如Flag的术语。状态变量不同于布尔变量的地方是它可以具有两个以上的可能值。不是使用documentFlag,而是使用更具描述性的名称,如documentFormatType。(此项只供参考) ?即使对于可能仅出现在几个代码行中的生存期很短的变量,仍然使用有意义的名称。仅对于短循环索引使用单字母变量名,如i或j。 ?可能的情况下,尽量不要使用原义数字或原义字符串,如For i = 1 To 7。而是使用命名常数,如For i = 1 To NUM_DAYS_IN_WEEK以便于维护和理解。 二、代码书写规范 格式化使代码的逻辑结构很明显。花时间确保源代码以一致的逻辑方式进行格式化,这对于您和你的开发小组,以及以后维护源代码的其他开发人员都有很大的帮助。 以下几点是推荐的格式化方法。

单片机C语言变量定义

单片机教程,51单片机C语言学习 第六课变量 上课所提到变量就是一种在程序执行过程中其值能不断变化的量。要在程序中使用变量必须先用标识符作为变量名,并指出所用的数据类型和存储模式,这样编译系统才能为变量分配相应的存储空间。定义一个变量的格式如下:[存储种类] 数据类型[存储器类型] 变量名表 在定义格式中除了数据类型和变量名表是必要的,其它都是可选项。存储种类有四种:自动(auto),外部(extern),静态(static)和寄存器(register),缺省类型为自动(auto)。这些存储种类的具体含义和用法,将在第七课《变量的存储》中进一步进行学习。 而这里的数据类型则是和我们在第四课中学习到的名种数据类型的定义是一样的。说明了一个变量的数据类型后,还可选择说明该变量的存储器类型。存储器类型的说明就是指定该变量在C51硬件系统中所使用的存储区域,并在编译时准确的定位。表6-1中是KEILuVision2所能认别的存储器类型。注意的是在AT89C51芯片中RAM只有低128位,位于80H到FFH的高128位则在52芯片中才有用,并和特殊寄存器地址重叠。特殊寄存器(SFR)的地址表请看附录二 如果省略存储器类型,系统则会按编译模式SMALL,COMPACT或LARGE所规定的默认存储器类型去指定变量的存储区域。无论什么存储模式都可以声明变量在任何的8051存储区范围,然而把最常用的命令如循环计数器和队列索引放在内部数据区可以显着的提高系统性能。还有要指出的就是变量的存储种类与存储器类型是完全无关的。 SMALL存储模式把所有函数变量和局部数据段放在8051系统的内部数据存储区这使访问数据非常快,但SMALL存储模式的地址空间受限。在写小型的应用程序时,变量和数据放在data内部数据存储器中是很好的因为访问速度快,但在较大的应用程序中data区最好只存放小的变量、数据或常用的变量(如循环计数、数据索引),而大的数据则放置在别的存储区域。 COMPACT存储模式中所有的函数和程序变量和局部数据段定位在8051系统的外部数据存储区。外部数据存储区可有最多256字节(一页),在本模式中外部数据存储区的短地址用@R0/R1。

C语言的规范(非常经典)

C语言的规范 C语言的规范2007-11-03 08:20A.1 排版 1-1:程序块要采用缩进风格编写,缩进的TAB键一个。 1-2:相对独立的程序块之间、变量说明之后必须加空行。 1-3:较长的语句(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。 1-4:循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首。 1-5:若函数或过程中的参数较长,则要进行适当的划分。 1-6:不允许把多个短语句写在一行中,即一行只写一条语句。 1-7:if、while、for、default、do等语句自占一行。 1-8:对齐只使用TAB键,不使用空格键。 1-9:函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,ca se语句下的情况处理语句也要遵从语句缩进要求。 1- 10:程序块的分界符(如C/C++语言的大括号'{'和'}')应各独占一行并且位于同一列,同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while0、switch、case语句中的程序都要采用如上的缩进方式。 1-11:在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如->),后不应加空格。 1-12: 程序结构清析,简单易懂,单个函数的程序行数不得超过100行。 A.2 注释 2-1:一般情况下,源程序有效注释量必须在20%以上。 2-2:说明性文件(如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。 2-3:源文件头部应进行注释,列出:版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。 2-4:函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。 2-5:边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。 2-6:注释的内容要清楚、明了,含义准确,防止注释二义性。 2-7:避免在注释中使用缩写,特别是非常用缩写。 2-8:注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。 2-9:对于所有有物理含义的变量、常量,如果其命名不是充分自注释的,在声明时都必须加以注释,说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。 2-10:数据结构声明(包括数组、结构、类、枚举等),如果其命名不是充分自注释的,必须加以注释。对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释放在此域的右方。 2-11:全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。

C语言基础知识(详细版)

C语言程序的结构认识 用一个简单的c 程序例子,介绍c 语言的基本构成、格式、以及良好的书写风格,使小伙伴对 c 语言有个 初步认识。 例1:计算两个整数之和的c 程序: #include main() { int a,b,sum; /* 定义变量a,b ,sum 为整型变量*/ a=20; /* 把整数20 赋值给整型变量a*/ b=15; /* 把整数15 赋值给整型变量b*/ sum=a+b; /* 把两个数之和赋值给整型变量sum*/ printf( “ a=%d,b=%d,sum=%d\n” ,a,b,sum); /* 把计算结果输出到显示屏上*/ } 重点说明: 1、任何一个c 语言程序都必须包括以下格式: main() { } 这是c 语言的基本结构,任何一个程序都必须包含这个结构。括号内可以不写任何内容,那么该程序将不执行任何结果。 2、main() - 在c 语言中称之为“主函数” ,一个c 程序有且仅有一个main 函数,任何一个c 程序总是从 main 函数开始执行,main 函数后面的一对圆括号不能省略。 3、被大括号{ }括起来的内容称为main 函数的函数体,这部分内容就是计算机要执行的内容。 4、在{ }里面每一句话后面都有一个分号(; ),在c 语言中,我们把以一个分号结尾的一句话叫做一个 c 语 言的语句,分号是语句结束的标志。 5、printf( “ a=%d,b=%d,sum=%d\n” ,a,b,sum); 通过执行这条c 语言系统提供给我们直接使用的屏幕输出 函数,用户即可看到运行结果,本程序运行后,将在显示器上显示如下结果: a=20,b=15,sum=35 6、#include 注意:(1)以#号开头 (2)不以分号结尾这一行没有分号,所以不是语句,在c 语言中称之为命令行,或者叫做“预编译处理命令” 。 7、程序中以/* 开头并且以*/ 结尾的部分表示程序的注释部分,注释可以添加在程序的任何位置,为了提高程序的可读性而添加,但计算机在执行主函数内容时完全忽略注释部分,换而言之就是计算机当做注释部分不存在于主函数中。 C程序的生成过程 C程序是先由源文件经编译生成目标文件,然后经过连接生成可执行文件。 源程序的扩展名为.c ,目标程序的扩展名为.obj , 可执行程序的扩展名为.exe 。

单片机C语言变量定义定稿版

单片机C语言变量定义 HUA system office room 【HUA16H-TTMS2A-HUAS8Q8-HUAH1688】

单片机教程,51单片机C语言学习 第六课变量 上课所提到变量就是一种在程序执行过程中其值能不断变化的量。要在程序中使用变量必须先用标识符作为变量名,并指出所用的数据类型和存储模式,这样编译系统才能为变量分配相应的存储空间。定义一个变量的格式如下: [存储种类] 数据类型[存储器类型] 变量名表 在定义格式中除了数据类型和变量名表是必要的,其它都是可选项。存储种类有四种:自动(auto),外部(extern),静态(static)和寄存器(register),缺省类型为自动(auto)。这些存储种类的具体含义和用法,将在第七课《变量的存储》中进一步进行学习。 而这里的数据类型则是和我们在第四课中学习到的名种数据类型的定义是一样的。说明了一个变量的数据类型后,还可选择说明该变量的存储器类型。存储器类型的说明就是指定该变量在C51硬件系统中所使用的存储区域,并在编译时准确的定位。表6-1中是KEIL uVision2所能认别的存储器类型。注意的是在AT89C51芯片中RAM只有低128位,位于80H到FFH的高128位则在52芯片中才有用,并和特殊寄存器地址重叠。特殊寄存器(SFR)的地址表请看附录二AT89C51特殊功能寄存器列表

表6-1 存储器类型 如果省略存储器类型,系统则会按编译模式SMALL,COMPACT或LARGE所规定的默认存储器类型去指定变量的存储区域。无论什么存储模式都可以声明变量在任何的8051存储区范围,然而把最常用的命令如循环计数器和队列索引放在内部数据区可以显着的提高系统性能。还有要指出的就是变量的存储种类与存储器类型是完全无关的。

关于C语言编程书写规范的规则和建议

关于C语言编程书写规范的规则和建议 一、头文件 ?头文件由三部分内容组成: 1、头文件开头处的版权和版本声明。 2、预处理块。 3、函数和类结构声明等。 ?【规则】为了防止头文件被重复引用,应当用ifndef/define/endif结构产生预处理块。 ?【规则】用#include 格式来引用标准库的头文件(编译器将从标准库目录开始搜索). ?【规则】用#include “filename.h”格式来引用非标准库的头文件(编译器将从用户的工作目录开始搜索) ?【建议】头文件中只存放“声明”而不存放“定义” ?【建议】不提倡使用全局变量,尽量不要在头文件中出现象extern int value 这类声明。 二、程序的版式 空行 ?【规则】在每个类声明之后、每个函数定义结束之后都要加空行。 ?【规则】在一个函数体内,逻揖上密切相关的语句之间不加空行,其它地方应加空行分隔。 代码行 ?【规则】一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且方便于写注释。 ?【规则】if、for、while、do等语句自占一行,执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。 ?【建议】尽可能在定义变量的同时初始化该变量(就近原则) 代码行内的空格 ?【规则】关键字之后要留空格。象const、virtual、inline、case 等关键字之后至少要留一个空格,否则无法辨析关键字。象if、for、while等关键字之后应留一个空格再跟左括号‘(’,以突出关键字。 ?【规则】函数名之后不要留空格,紧跟左括号‘(’,以与关键字区别。 ?【规则】‘(’向后紧跟,‘)’、‘,’、‘;’向前紧跟,紧跟处不留空格。 ?【规则】‘,’之后要留空格,如Function(x, y, z)。如果‘;’不是一行的结束符号,其后要留空格。 ?【规则】赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符,如“=”、“+=”“>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”,“^”等二元操作符的前后应当加空格。 ?【规则】一元操作符如“!”、“~”、“++”、“--”、“&”(地址运算符)等前后不加空格。 ?【规则】象“[]”、“.”、“->”这类操作符前后不加空格。 ?【建议】对于表达式比较长的for语句和if语句,为了紧凑可以适当地去掉一些空格,如for (i=0; i<10; i++)和if ((a<=b) && (c<=d)) 对齐 ?【规则】程序的分界符‘{’和‘}’应独占一行并且位于同一列,同时与引用它们的语句左对齐。 ?【规则】{ }之内的代码块在‘{’右边数格处左对齐。 长行拆分 ?【规则】代码行最大长度宜控制在70至80个字符以内。代码行不要过长,否则眼睛看不过来,也不便于打印。 ?【规则】长表达式要在低优先级操作符处拆分成新行,操作符放在新行之首(以便突出操作符)。拆分出的新行要进行适当的缩进,使排版整齐,语句可读。

c语言规范5.0中文版

竭诚为您提供优质文档/双击可除c语言规范5.0中文版 篇一:c语言设计规范 篇二:关于c语言编程书写规范的规则和建议 关于c语言编程书写规范的规则和建议 一、头文件 1、头文件开头处的版权和版本声明。 2、预处理块。 3、函数和类结构声明等。头文件由三部分内容组成:【规则】为了防止头文件被重复引用,应当用 ifndef/define/endif结构产生预处理块。 【规则】用#include格式来引用标准库的头文件(编译器将从标准库目录开始搜索). 【规则】用#include“filename.h”格式来引用非标准库的头文件(编译器将从用户的工作目录开始搜索)【建议】头文件中只存放“声明”而不存放“定义” 【建议】不提倡使用全局变量,尽量不要在头文件中出现象externintvalue这类声明。 二、程序的版式 空行

【规则】在每个类声明之后、每个函数定义结束之后都要加空行。 【规则】在一个函数体内,逻揖上密切相关的语句之间不加空行,其它地方应加空行分隔。 代码行 【规则】一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且方便于写注释。【规则】if、for、while、do等语句自占一行,执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。【建议】尽可能在定义变量的同时初始化该变量(就近原则) 代码行内的空格 【规则】关键字之后要留空格。象const、virtual、inline、case等关键字之后至少要留一个空格,否则无法辨析关键字。象if、for、while等关键字之后应留一个空格再跟左括号 ‘(’,以突出关键字。 【规则】函数名之后不要留空格,紧跟左括号‘(’,以与关键字区别。 【规则】‘(’向后紧跟,‘)’、‘,’、‘;’向前紧跟,紧跟处不留空格。 【规则】‘,’之后要留空格,如Function(x,y,z)。如 果‘;’不是一行的结束符号,其后要留空格。

C语言软件编写规范

C语言软件编写规范 以下是为大家整理的c语言软件编写规范的相关范文,本文关键词为语言,软件,编写,规范,北京,森馥,科技,股份有限公司,前言,您可以从右上方搜索框检索更多相关文章,如果您觉得有用,请继续关注我们并推荐给您的好友,您可以在教育文库中查看更多范文。 北京森馥科技股份有限公司 前言: 一个好的程序编写规范是编写高质量程序的保证。清晰、规范的源程序不仅仅是方便阅读,更重要的是能够便于检查错误,提高调试

效率,从而最终保证软件的质量和可维护性。 说明: 本规范适用于公司内使用c语言编码的所有软件。本规范自发布之日起生效,以后新编写的和修改的代码应遵守本规范。 注:使用固件和操作系统源代码应保留其代码风格 1 北京森馥科技股份有限公司 目录 1.排版与格式................................................................................................................. ....................................32.标识符命名与定义................................................................................................................. ........................43.注释书写规范................................................................................................................. .. (6) 2 北京森馥科技股份有限公司 1.排版与格式 规则1:程序块采用缩进风格编写,每级缩进为4个空格。 程序块采用缩进风格编写,每级缩进为4个空格,不使用TAb键,

c语言函数命名规范

竭诚为您提供优质文档/双击可除 c语言函数命名规范 篇一:c语言命名规则 匈牙利命名法是微软推广的一种关于变量、函数、对象、前缀、宏定义等各种类型的符号的 命名规范。匈牙利命名法的主要思想是:在变量和函数名中加入前缀以增进人们对程序的理 解。它是由微软内部的一个匈牙利人发起使用的,结果它在微软内部逐渐流行起来,并且推 广给了全世界的windows开发人员。下面将介绍匈牙利命名法,后面的例子里也会尽量遵守 它和上面的代码风格。 aarray数组 bbool(int)布尔(整数) byunsignedchar(byte)无符号字符(字节) cchar字符(字节) cbcountofbytes字节数 crcolorreferencevalue颜色(参考)值 cxcountofx(short)x的集合(短整数)

dwdwoRd(unsignedlong)双字(无符号长整数) fFlags(usuallymultiplebitvalues)标志(一般是有多位的数值) fnFunction函数 g_global全局的 hhandle句柄 iinteger llong lplongpointer m_datamemberofaclass 成员 nshortint ppointer sstring szzeroterminatedstring 符串 tmtextmetric uunsignedint ulunsignedlong(ulong)整数长整数长指针一个类的数据短整数指针字符串以0结尾的字文本规则无符号整数无符号长整数 wwoRd(unsignedshort)无符号短整数

C++变量命名规则

C++变量命名规则2008-09-03 14:48a Array 数组 b BOOL (int) 布尔(整数) by Unsigned Char (Byte) 无符号字符(字节) c Char 字符(字节) cb Count of bytes 字节数 cr Color reference value 颜色(参考)值 cx Count of x (Short) x的集合(短整数) dw DWORD (unsigned long) 双字(无符号长整数) f Flags (usually multiple bit values) 标志(一般是有多位的数值) fn Function 函数 g_ global 全局的 h Handle 句柄 i Integer 整数 l Long 长整数 lp Long pointer 长指针 m_ Data member of a class 一个类的数据成员 n Short int 短整数 p Pointer 指针 s String 字符串 sz Zero terminated String 以0结尾的字符串 tm Text metric 文本规则 u Unsigned int 无符号整数

ul Unsigned long (ULONG) 无符号长整数 w WORD (unsigned short) 无符号短整数 x,y x, y coordinates (short) 坐标值/短整数 v void 空 有关项目的全局变量用g_开始,类成员变量用m_,局部变量若函数较大则可考虑用l_用以显示说明其是局部变量。 前缀类型例子 g_ 全局变量g_Servers C 类或者结构体CDocument,CPrintInfo m_ 成员变量m_pDoc,m_nCustomers VC常用前缀列表: 前缀类型描述例子 ch char 8位字符chGrade ch TCHAR 16位UNICODE类型字符chName b BOOL 布尔变量bEnabled n int 整型(其大小由操作系统决定)nLength n UINT 无符号整型(其大小由操作系统决定)nLength

c语言代码书写规范

c语言代码书写规范 篇一:关于C语言编程书写规范的规则和建议 关于C语言编程书写规范的规则和建议 一、头文件 1、头文件开头处的版权和版本声明。 2、预处理块。 3、函数和类结构声明等。 ? 头文件由三部分内容组成: ? 【规则】为了防止头文件被重复引用,应当用ifndef/define/endif结构产生预处理块。 ? 【规则】用 #include 格式来引用标准库的头文件(编译器将从标准库目录开始搜索). ? 【规则】用 #include “”格式来引用非标准库的头文件(编译器将从用户的工作目录开始搜索) ? 【建议】头文件中只存放“声明”而不存放“定义” ? 【建议】不提倡使用全局变量,尽量不要在头文件中出现象extern int value 这类声明。 二、程序的版式 空行 ? 【规则】在每个类声明之后、每个函数定义结束之

后都要加空行。 ? 【规则】在一个函数体内,逻揖上密切相关的语句之间不加空行,其它地方应加空行分隔。 代码行 ? 【规则】一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且方便于写注释。 ? 【规则】if、for、while、do等语句自占一行,执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。 ? 【建议】尽可能在定义变量的同时初始化该变量(就近原则) 代码行内的空格 ? 【规则】关键字之后要留空格。象const、virtual、inline、case 等关键字之后至少要留一个空格,否则无法辨析关键字。象if、for、while等关键字之后应留一个空格再跟左括号‘(’,以突出关键字。 ? 【规则】函数名之后不要留空格,紧跟左括号‘(’,以与关键字区别。 ? 【规则】‘(’向后紧跟,‘)’、‘,’、‘;’向前紧跟,紧跟处不留空格。

相关文档
最新文档