C++代码书写要求

合集下载

c语言3大基本结构

c语言3大基本结构

c语言3大基本结构C语言是一种广泛应用的编程语言,其简洁高效的特点使其成为了许多程序员的首选语言。

在学习C语言时,了解它的基本结构是非常重要的。

C语言中有三个基本结构,分别是顺序结构、选择结构和循环结构。

下面将详细介绍这三种基本结构。

一、顺序结构顺序结构是指程序按照代码书写顺序依次执行的过程。

在C语言中,每一行代码都会按照书写顺序被执行。

例如:```#include <stdio.h>int main(){printf("Hello, World!\n");printf("This is my first C program.\n");return 0;}```以上代码就是一个典型的顺序结构程序。

程序从第一行开始执行,按照代码书写顺序依次执行每一行代码,直到程序结束。

二、选择结构选择结构是指根据条件判断来决定程序执行哪些代码段。

在C语言中,选择结构主要有if语句和switch语句两种形式。

1. if语句if语句可以根据条件判断来决定是否执行某段代码。

其基本形式如下:```if (condition){// 如果condition为真,则执行这里的代码}else{// 如果condition为假,则执行这里的代码}```例如:```#include <stdio.h>int main(){int a = 10;if (a > 0){printf("a是正数\n");}else{printf("a是负数或零\n");}return 0;}```以上代码中,if语句根据变量a的值判断是否为正数,如果是则输出"a是正数",否则输出"a是负数或零"。

2. switch语句switch语句也可以根据条件判断来决定执行哪些代码段。

其基本形式如下:```switch (expression){case value1:// 如果expression等于value1,则执行这里的代码break;case value2:// 如果expression等于value2,则执行这里的代码break;default:// 如果expression不等于任何一个case中的值,则执行这里的代码break;}```例如:```#include <stdio.h>int main(){int score = 85;switch (score / 10) {case 10:case 9:printf("优秀\n"); break;case 8:printf("良好\n"); break;case 7:printf("中等\n");break;case 6:printf("及格\n");break;default:printf("不及格\n");break;}return 0;}```以上代码中,switch语句根据变量score的值判断成绩等级,根据不同的分数段输出不同的信息。

C语言编程规范与代码风格

C语言编程规范与代码风格

C语言编程规范与代码风格在C语言编程过程中,遵循一定的编程规范和代码风格是非常重要的。

这不仅可以提高代码的可读性和可维护性,还有利于团队协作和代码质量的保证。

下面将介绍一些常用的C语言编程规范与代码风格。

1. 缩进与对齐:在C语言中,缩进和对齐是非常重要的,可以通过统一的缩进方式使代码更加清晰易读。

通常情况下,我们建议使用4个空格进行缩进,并且在代码块开始和结束处进行对齐,以增强代码结构的可读性。

2. 命名规范:良好的命名规范可以使代码更易于理解和维护。

变量名、函数名、常量名等应该具有描述性,体现其功能和用途。

通常采用驼峰命名法或下划线分隔命名法,避免使用拼音或缩写。

3. 注释:注释是代码文档化和功能解释的重要手段,应该充分利用注释来解释代码的作用、原理和设计思路,以方便他人理解和维护代码。

建议在函数开头添加注释说明函数的功能、参数意义和返回值等信息。

4. 函数封装:在进行函数设计时,应该遵循单一职责原则,保持函数的功能单一性,每个函数只实现一个功能。

同时尽量避免函数过长,可以根据需要进行适当的分解和封装,以便于代码的复用和维护。

5. 错误处理:在编写C语言程序时,要充分考虑错误处理机制,避免出现未处理的异常情况。

可以通过返回值、错误码或异常处理等方式来处理各种可能的错误,以保证程序的稳定性和可靠性。

6. 模块化设计:模块化是提高代码复用性和可维护性的有效手段,可以将功能相似的代码封装成独立的模块,提供统一的接口供其他模块调用。

通过模块化设计,可以降低程序的耦合度,提高代码的灵活性和可扩展性。

7. 代码风格:统一的代码风格可以使代码更加整洁和规范,方便团队开发和代码审查。

应遵循一定的代码书写规范,包括变量命名、函数封装、代码结构等方面,以确保代码风格的一致性和统一性。

总之,遵循良好的C语言编程规范与代码风格对于提高代码质量和开发效率至关重要。

通过统一的编程规范和代码风格,可以使代码更易于理解、维护和扩展,同时也有利于团队协作和代码质量的保证。

C语言编码规范

C语言编码规范

z if、for、while、switch等与后面的括号间应加空格,使if等关键字更为突出、明显。 if (a >= b && c > d)
USTB ROBOTEAM
C 语言编码规范
可读性
z I注意运算符的优先级,并用括号明确表达式的操作顺序,避免使用默认优先级。
说明:防止阅读程序时产生误解,防止因默认的优先级与设计思想不符而导致程序出错。 示例:下列语句中的表达式
Description: a short introduction of this module.
Revision History:
Date
Rel Ver. Noຫໍສະໝຸດ esmonth/day/year
x.x [e.g.] Module created
***********************************************************/
/* code two comments */ program code two
USTB ROBOTEAM
C 语言编码规范
6. 在代码的功能、意图层次上进行注释,提供有用、额外的信息。 说明:注释的目的是解释代码 的目的、功能和采用的方法,提供代码以外的信息,帮助读者理解代码,防止没必要的重复注 释信息。 例如:如下注释意义不大。 /* if receive_flag is TRUE */ if (receive_flag) 而如下的注释则给出了额外有用的信息。 /* if mtp receive a message from links */ if (receive_flag)
word = (high << 8) | low (1)

c语言编码规范

c语言编码规范

c语言编码规范1. 定义要求(1)C语言编码规范是指以C语言为基础的各大编程规范,它包含了C语言编写编程风格,命名规范,编程结构规范,编程语句规范等,让C语言编程更加规范、整洁。

2. 风格规范(1)关键字需大写书写,函数名、变量名等由于字母的组合,需要全部小写,每个单词首字母大写;(2)变量名不同部分用下划线相隔,如count_day;(3)变量名、宏定义尽量以字母为主,如类似变量temp1,应以temp_num或tmp_num标出;(4)如果是boolean变量,用is_,has_,can_,should_等来开头;(5)结构体变量名以st_开头,指针变量以p_开头;(6)变量命名规避使用数字或关键字作为变量名,变量有一定的含义。

3.命名规则(1)变量名称需要清晰容易识别,最大限度的体现变量定义的含义;(2)动词开头的函数名,如GetValue();(3)禁止使用拼音代替英文原语的单词,如使用Genarate代替Generate;(4)宏定义加上宏定义的作用,方便查阅,如#define MAX_NUM 10;4.编码规范(1)大括号{}要和函数声明、if语句、循环等放在同一行,同一行必须以分号结束;(2)避免使用复杂的表达式,尽量简化表达式,提高程序执行效率;(3)函数的入口参数必须在一行完成,不允许一行就只声明一个参数;(4)使用空行表示程序模块,增加程序可读性;(5)赋值操作、声明操作分开,以便于断点调试及阅读。

5.注释规范(1)注释需要给出功能说明、操作提示等,不只是单纯的注释源码,使代码更易理解;(2)代码块开头加一个注释表明代码块作用,方便阅读;(3)函数声明后增加功能注释,注释必须完整,包括函数的功能简介,参数说明,返回值等;(4)注释中禁止出现脏话、宗教意象、广告语等。

C_C++编程规范-华为标准-精

C_C++编程规范-华为标准-精
值范围及公共变量间的关系。 5-3:明确公共变量与操作此公共变量的函数或过
程的关系,如访问、修改及创建等。 5-4:当向公共变量传递数据时,要十分小心,防
止赋与不合理的值或越界等现象发生。 5-5:防止局部变量与公共变量同名。 5-6:严禁使用未经初始化的变量作为右值。
编程规范详解——函数、过程 处理。
1-11:在两个以上的关键字、变量、常量进行对等操作时,它们之间 的操作符之前、之后或者前后要加空格;进行非对等操作时,如果 是关系密切的立即操作符(如->),后不应加空格。
1-12: 程序结构清析,简单易懂,单个函数的程序行数不得超过100行。
编程规范详解——注释
2-1:一般情况下,源程序有效注释量必须在20%以上。 2-2:说明性文件(如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg
编程规范详解——注释
2-9:对于所有有物理含义的变量、常量,如果其命名不是充分自注释的,在 声明时都必须加以注释,说明其物理含义。变量、常量、宏的注释应放在 其上方相邻位置或右方。
2-10:数据结构声明(包括数组、结构、类、枚举等),如果其命名不是充分自 注释的,必须加以注释。对数据结构的注释应放在其上方相邻位置,不可 放在下面;对结构中的每个域的注释放在此域的右方。
后进入下一个case处理,必须在该case语句处理完、下一个case语句前加 上明确的注释。
编程规范详解——标识符的命名
3-1:标识符的命名要清晰、明了,有明确含义,同时使用完 整的单词或大家基本可以理解的缩写,避免使人产生误解。
3-2:命名中若使用特殊约定或缩写,则要有注释说明 3-3:自己特有的命名风格,要自始至终保持一致,不可来回
延用华为标准
C/C++编程规范

c语言编程规范

c语言编程规范

C语言编程规范一、排版1.采用阶梯层次组织代码函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,case语句下的情况处理语句也要遵从语句缩进要求。

各层次缩紧的风格采用TAB缩进。

注意:右括号所在的行不应当有其它东西,除非跟随着一个条件判断。

也就是do-while语句中的“while”。

2.及时折行较长的语句(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进(至少1个TAB位置),使排版整齐,语句可读。

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

3.语句的书写格式1.一行只写一条语句2.switch、if、while、do、for规则如下:(1)switch语句的书写格式switch(ch){case 1://注释statements;break;case 2://注释statements;break;default://注释statements;break;}(2)if语句的书写格式If(条件){//注释statements;}else if(条件){//注释statements;}else{//注释statements;}(3)while语句的书写格式while(条件){statements;}(4)do语句的书写格式do{statements;}while(条件);//注释(5)for语句的书写格式for(...;...;...){//注释statements;}4.空行(1)变量说明之后必须加空行。

(2)相对独立的程序块之间应加空行。

5.空格(1)逗号、分号只在后面加空格。

int a,b,c;(2)比较操作符,赋值操作符“=”、“+=”,算术操作符“+”、“%”,逻辑操作符“&&”、“&”,位域操作符“<<”等双目操作符的前后加空格。

C语言的语法风格与代码书写规范指南

C语言的语法风格与代码书写规范指南

C语⾔的语法风格与代码书写规范指南C代码:#include <stdio.h>int main(void){printf("That is Right Style\n");return 0;}在⼀个标准的C语⾔程序中,最特殊的莫过于main函数了,⽽说到底它就是⼀个函数⽽已,仅仅因为它地位特殊拥有第⼀执⾏权⼒,换句话说,难道因为⼀个⼈是省长它就不是⼈类了?所以函数该有的它都应该有,那么函数还有什么呢?函数⼤体上分为内联函数(C99)(内联函数并⾮C++专属,C语⾔亦有,具体见前⽅链接)和⾮内联的普通函数,它们之间有⼀个很明显的特点(⼀般情况下),那就是不写原型直接在main函数上⽅定义,即使不加'inline'关键字,也能被编译器默认为内联函数,但之后带来的某些并发问题就不是编译器考虑的了。

普通函数正确的形式应该为声明与定义分离,声明就是⼀个函数原型,函数原型应该有⼀个函数名字,⼀个参数列表,⼀个返回值类型和⼀个分号。

定义就是函数的内在,花括号内的就是函数的定义://...int function(int arg_1, float arg_2);//...int main(int argc, char* argv[]){int output = function(11, 22.0);printf("%d\n",output);return 0;}int function(int arg_1, float arg_2){int return_value = arg_1;float temp_float = arg_2;return return_value;}依上所述,当⾮必要时,在⾃⼰编写函数的时候请注意在开头(main函数之前)写上你的函数的原型,并且在末尾(main函数之后)写上你的函数定义,这是⼀个很好的习惯以及规范。

所谓代码整洁之道,就是如此。

初识C语言编码规范

初识C语言编码规范

C语言编码规范1-排版规则程序应采用缩进风格编写,每层缩进使用一个制表位(TAB),类定义、方法都应顶格书写;源程序建议使用英文书写,尽量不含有中文。

每行不超过80字符。

对于较长的语句(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读;循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分;左花括号要另起一行,不能跟在上一行的行末;一个变量定义占一行,一个语句占一行;对独立的程序块之间、变量说明之后必须加空行;在结构成员赋值等情况,等号对齐,最少留一个空格;若函数或过程中的参数较长,则要进行适当的划分。

形参的排序风格:最常使用的参数放在第一位;输入参数列表应放在输出参数列表的左边;将通用的参数放在特殊的参数的左边。

2-命名规范应用程序的命名“系统简称”+模块名称子模块的命名每个子模块的名字应该由描述模块功能的1-3以单词组成。

每个单词的首字母应大写。

在这些单词中可以使用一些较通用的缩写。

变量的命名变量的命名的基本原则是使得变量的含义能够从名字中直接理解。

可以用多个英文单词拼写而成,每个英文单词的首字母要大写,其中英文单词有缩写的可用缩写;变量的前缀表示该变量的类型;对于作用域跨越10行以上的变量名称不能少于4个字符,除循环变量,累加变量外不得使用I、j、k等名称的变量。

变量分为取全局变量和局部变量,对于全局变量以加前缀“g_”来区分。

使用有意义的英语单词,使用大小写分隔,每个单词的第一个字母为大写考虑到习惯性和简洁性,对于按常规使用的局部变量允许采用极短的名字,如用n、i作为循环变量,p、q作为指针等。

另外,要注意的是:全局变量在程序中不要定义太多,能用局部变量的就用局部变量。

如果要使用相关的变量,建议采用类的方式或者结构的方式存放,以减少具体变量的个数。

常量的命名常量所有的字母均为大写。

并且单词之间使用下划线”_”隔开。

C语言程序代码编写规范

C语言程序代码编写规范

C语言程序代码编写规范一个好的程序编写规范是编写高质量程序的保证。

清晰、规范的源程序不仅方便阅读,更重要的是能够便于检查错误,提高调试效率,从而最终保证程序的质量和可维护性。

对于刚刚开始接触编程的初学者来说,尤其要遵循编程规范,培养良好的职业素养。

以下是一些最基本的代码编写规范。

1.命名规范(1)常量命名①符号常量的命名用大写字母表示,如#define LENGTH 10。

②如果符号常量由多个单词构成,两个不同的单词之间可以用下划线连接,如#define MAX_LEN 50。

(2)变量和函数命名①可以选择有意义的英文(小写字母)组成变量名,使读者看到该变量就能大致清楚其含义。

②不要使用人名、地名和汉语拼音。

③如果使用缩写,应该使用那些约定俗成的,而不是自己编造的。

④多个单词组成的变量名,除第一个单词外的其他单词首字母应该大写,如dwUserInputValue。

⑤对于初学者,函数命名可以采用FunctionName的形式。

2.代码书写规范(1)空格的使用①在逗号后面和语句中间的分号后面加空格,如int i,j;和for(i=0;i<n;i++)。

②在二目运算符的两边各留一个空格,如a>b 写成a > b③关键字两侧,如if()...,写成if() ...(2)缩进的设置根据语句间的层次关系采用缩进格式书写程序,每进一层,往后缩进一层。

有两种缩进方式,分别是使用Tab键和采用4个空格。

整个文件内部应该统一,不要混用Tab和4个空格,因为不同的编辑器对Tab键的处理方法不同。

(3)嵌套语句(语句块)的格式对于嵌套式的语句,即语句块(如if、while、for、switch等)应该包括在花括号中。

花括号的左括号应该单独占一行,并与关键字对齐。

建议即使语句块中只有一条语句,也应该使用花括号,这样可以使程序结构更清晰,也可以避免出错。

建议对比较长的程序块,在末尾的花括号后加上注释,以表明该语句块结束。

c程序书写规范

c程序书写规范

c,,程序书写规范篇一:C语言书写规范语言书写规范符号命名规则符号名包括模块名、常量名、标号名、子程序名等。

这些名字应该能反映它所代表的实际东西,具有一定的意义,使其能够见名知义,有助于对程序功能的理解。

命名采用匈牙利命名法。

规则如下:(1)所有宏定义、枚举常数和const变量,用大写字母命名。

在复合词里用下划线隔开每个词。

(2)复合词中每个单词的第一个字母大写。

除了规则以外,避免使用下划线。

(3)类、类型定义和枚举型名的第一个字母大写。

(4)函数名是复合词的,第一个词采用全部小写,随后每个单词采用第一个字母大写,其它字母小写方式;如果是单个词的,采用全部小写方式。

(5)循环变量可采用i, j, k等,不受上述规则限制。

(6) 类的成员变量应采用m_开头。

(7) 全局变量词头为g_ 。

(8) 临时变量词头为tmp_ 。

(9) 对结构体内的变量命名, 遵循变量的具体含义命名原则(10)用小写字母的前缀表示变量的类型,前缀的下一个字母用大写。

表 1词头类型词头类型ch char l longi integer u unsignedb boolean p pointerf float lp long pointerd double s stringst structure sz ASCII stringby byte n short intH handle x,y 分别为x,y坐标dw DWORD fn function表 2词头变量名词头变量名task task sig signalsb binary semaphores wd watchdog sm mutual exclusionsemaphores tm timersc counting semaphores msg message pipe pipe例:#define ARRAY_SIZE 24 /*规则*/int g_iFlag;class MyClass /*规则*/{};void someFunc( ) /*规则和*/{.2.Q/ECC/BJ 010—XXint nArray[ARRAY_SIZE];unsigned char uchByte;char szName[ ];char *pszName = szName;}(11)有些词头(如p和u)可以和其它词头组合。

C语言格式书写要求规范

C语言格式书写要求规范

C语言书写规指南第1章文件结构每个C程序通常分为两个文件。

一个文件用于保存程序的声明(declaration),称为头文件。

另一个文件用于保存程序的实现(implementation),称为定义(definition)文件。

C程序的头文件以“.h”为后缀,C程序的定义文件以“.c”为后缀。

1.1和版本的声明和版本的声明位于头文件和定义文件的开头(参见示例1-1),主要容有:(1)信息。

(2)文件名称,标识符,摘要。

(3)当前版本号,作者/修改者,完成日期。

(4)版本历史信息。

/**Copyright(c)2001,大学物理学院无线电*Allrightsreserved.**文件名称:filename.h*文件标识:*摘要:简要描述本文件的容**当前版本: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 <filename.h>格式来引用标准库的头文件(编译器将从标准库目录开始搜索)。

【规则1-2-3】用#include “filename.h”格式来引用非标准库的头文件(编译器将从用户的工作目录开始搜索)。

【规则1-2-4】#include 后面使用TAB键控制排版。

【规则1-2-5】头文件中只存放“声明”而不存放“定义”【规则1-2-6】全局变量在头文件中声明,在.c文件中定义.h extern in tvalue; 声明。

C语言中的代码规范与风格指南

C语言中的代码规范与风格指南

C语言中的代码规范与风格指南在编写C语言代码时,遵循一定的代码规范和风格是非常重要的,因为良好的代码规范和风格可以提高代码的可读性、可维护性和可靠性。

本文将介绍一些常用的C语言代码规范和风格指南,帮助你写出高质量的C语言代码。

1. 缩进和空格:在C语言中,通常使用空格或制表符来进行缩进,建议使用4个空格来进行缩进,而不是制表符。

缩进可以使代码结构更清晰,便于阅读和理解。

2. 变量命名:变量命名应具有描述性,能够清晰地表达变量的用途。

通常采用驼峰命名法或下划线命名法,确保变量名简洁明了,避免使用单个字母或无意义的缩写。

3. 函数和类命名:函数和类的命名应该具有描述性,能够清晰地表达函数或类的功能。

同样,采用驼峰命名法或下划线命名法,并且避免使用单个字母或无意义的缩写。

4. 注释:在代码中添加适当的注释是很有必要的,可以帮助其他人理解你的代码。

注释应该清楚简洁,解释代码的用途和功能,而不是重复代码本身。

注释应该使用英文书写,可以在每行代码末尾添加注释,也可以在代码块之上添加注释。

5. 括号和空格:在C语言中,通常要求在控制结构(如if、for、while等)的左括号前加一个空格,在右括号后也加一个空格。

这有助于代码的可读性,使代码更加整洁。

6. 单行代码长度:尽量避免单行代码过长,一般建议不超过80个字符。

如果一行代码过长,可以考虑将其分成多行,以提高代码的可读性。

7. 常量命名:常量命名通常使用大写字母和下划线,以便与变量区分。

在定义常量时,应该使用const关键字明确指定,避免出现魔法数字。

8. 函数长度:编写函数时,尽量保持函数长度的可控制性,避免函数过长。

如果函数过长,可以考虑将其拆分成多个函数,提高代码的可维护性。

9. 错误处理:在代码中添加适当的错误处理是非常重要的,可以保证程序的稳定性和可靠性。

应该考虑所有可能出现的错误情况,并进行适当处理,包括错误码返回、异常处理等。

总之,遵循良好的代码规范和风格指南可以帮助我们编写出高质量、易读、易维护的C语言代码。

C、C++代码规范

C、C++代码规范

C、C++代码规范2014.09.24目录第一章原则 (3)第二章排版 (4)2.1 空行 (4)2.2 代码行 (5)2.3 代码行内的空格 (6)2.4 对齐缩进 (7)2.5 长行拆分 (8)第三章注释 (10)3.1 通用规则 (10)3.2 文件注释 (10)3.3 函数注释 (11)3.4 数据注释 (12)3.5 代码注释 (13)第四章命名 (16)4.1 通用命名规则 (16)4.2 变量命名 (16)4.3 常量命名 (17)第五章杂项 (18)第一章原则本文档的目的是提供一个公共的编码规范。

这个规范详细阐述在编码时要怎样写、不要怎样写,旨在提高代码的可读性、可维护性,使代码易于管理,使所有人可以集中精力去实现内容,而非处理各种复杂的表现形式。

使代码易于管理的方法之一是增强代码一致性,让别人可以读懂你的代码是很重要的,保持统一编程风格意味着可以轻松根据“模式匹配”规则推断各种符号的含义。

创建通用的、必需的习惯用语和模式可以使代码更加容易理解。

虽然在某些情况下改变一些编程风格可能会是好的选择,但我们还是应该遵循一致性原则,尽量不这样去做。

关键在于保持一致。

第二章排版2.1空行●【规则2-1-1】在每个函数、结构体、枚举、类定义结束之后都要加空行。

●【规则2-1-2】在一个函数体内,逻辑密切相关的语句之间不加空行,其它地方应加空行分隔。

struct st1{…};// 空行enum{…};// 空行void Function1(…) {…}// 空行void Function2(…) {…} // 空行while (condition) {statement1;// 空行if (condition){statement2;}else{statement3;}// 空行statement4;}函数之间的空行函数内部的空行●【规则2-1-3】相对独立的程序块之间、变量说明之后必须加空行。

c_code_style

c_code_style

C 语言程序代码书写风格建议一. 关于注释1. 在每个文件的开始要添加注释,说明该文件的内容、作者、与其他文件的关系(在整个工程中的作用),文件的创建日期(时间)、最后的修改日期(时间),甚至是修改日志等信息。

例如:2. 注释要适量,不能不足也不宜太多,要尽量利用标识符命名的“自注释性”(参阅第三部分第1条)。

3. 单行注释推荐使用“//”,多行注释可以使用“//”,也可以使用“/* …… */”的形式,推荐遵守如下格式:4.函数原型在声明时要有完备的注释,说明函数的功能,描述函数的参数列表以及返回值(因为这是对一个接口的描述,要让读者看了这些注释就知道这个函数该如何使用)。

例如:说明函数功能参数描述返回值描述5.一个函数体或代码“语句块”结束,要尽量明确注释出结束标志“endfunction()……”等,对于比较长的(尤其是破坏程序二维直观视图的)循环(for、while、do...while)的循环体或分支结构(if、if...else、switch)语句块,也尽量做这样的结束标志性注释,例如:指明函数实现结束,呼应函数开始指明分支结构结束二.关于变量、常量的声明1.提倡一个函数内的所有变量都集中在函数刚开始的部分声明,而不是等到使用时才声明,这样做是为了保证同旧系统的兼容性,同时也保证了代码的整洁性;每一个变量的声明都应该附有注释,如下图所示:集中于函数开始部分的变量声明及其注释2.如果可以,尽量在变量声明的同时初始化它们,即赋初值,以避免该变量的值在第一次使用时处于一种无意义的状态;如果没有明确的初始值,则一般按照下面的方式初始化变量:1)数值型变量初始化为0,注意各种数值类型的不同书写方式(long int为“0L”,浮点型为“0.0”等);2)字符型变量初始化为“\0”(字符串要将其中的每一个字符初始化);3)指针型变量初始化为“NULL”;4)布尔型变量初始化为“false”。

3.每一行最好只声明一个变量,即使他们的数据类型是相同的,即尽量避免出现诸如“int a, b, c”这样的声明方式;所有变量声明结束后要和下文的代码间隔开一行。

经典C编程规范完整篇

经典C编程规范完整篇
02
2 注释
C语言编程规范
注释
1
2-1:一般情况下,源程序有效注释量必须在20%以上。
2
C语言编程规范
2 注释
C语言编程规范
/************************************************* Copyright (C), 1988-1999, Huawei Tech. Co., Ltd. File name: // 文件名 Author: Version: Date: // 作者、版本及完成日期 Description: // 用于详细说明此程序文件完成的主要功能,与其他模块 // 或函数的接口,输出值、取值范围、含义及参数间的控 // 制、顺序、独立或依赖等关系 Others: // 其它内容的说明 Function List: // 主要函数列表,每条记录应包括函数名及功能简要说明 1. .... History: // 修改历史记录列表,每条修改记录应包括修改日期、修改 // 者及修改内容简述 1. Date: Author: Modification: 2. ... *************************************************/
应如下书写 for (...) { ... // program code } if (...) { ... // program code } void example_fun( void ) { ... // program code }
C语言编程规范
1 排版
1-11:在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如->),后不应加空格。 说明:采用这种松散方式编写代码的目的是使代码更加清晰。 由于留空格所产生的清晰性是相对的,所以,在已经非常清晰的语句中没有必要再留空格.如括号内侧(即左括号后面和右括号前面)不需要加空格,多重括号间不必加空格,因为在C/C++语言中括号已经是最清晰的标志了。 在长语句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部不加空格。给操作符留空格时不要连续留两个以上空格。

代码书写规范(C .NET)

代码书写规范(C .NET)

代码书写规范(C#.NET)Version:1.0 目录目录类书写标准(C#.NET) (1)目录 (1)1 目的 (2)2 编码规范 (2)2.1 代码格式 (2)2.2 顶部声明内容 (3)2.3 方法位置 (3)2.4 #Region使用.................................................................................. 错误!未定义书签。

3 注释规范 (4)3.1 模块(类)注释规范 (4)3.2 类属性注释规范 (5)3.3 方法注释规范 (5)3.4 代码间注释规范 (5)4 命名规范 (6)4.1类命名规范 (6)4.2 成员变量 (6)4.3 局部变量 (6)4.4 资源命名 (6)4.5 其他命名 (6)4.6 命名注意 (7)5. 模板类 (7)1 编写目的为了保证编写出的程序都符合相同的规范,保证一致性、统一性而建立的程序编码规范。

编码规范对于程序员而言尤为重要,有以下几个原因:1.一个软件的生命周期中,80%的花费在于维护。

2.几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护。

3.编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的代码。

为了执行规范,每个软件开发人员必须一致遵守编码规范!2 目录结构规范(1)目录建立的原则:以最少的层次提供最清晰简便的访问结构。

(2)目录的命名以小写英文字母,下划线组成。

(参照命名规范)。

(3)根目录一般只存放index.htm以及其他必须的系统文件;每个主要栏目开设一个相应的独立目录;根目录下的images用于存放各页面都要使用的公用图片,子目录下的 images目录存放本栏目页面使用的私有图片。

(4)所有JS,ASP,PHP等脚本存放在根目录下的scripts目录。

(5)所有CGI程序存放在根目录下的cgi-bin目录。

(6)所有CSS文件存放在根目录下style目录。

c语言执行标准

c语言执行标准

C语言执行标准C语言是一种广泛使用的编程语言,其执行标准对于程序员来说非常重要。

下面从八个方面介绍了C语言的执行标准。

1. 语言语法C语言的语法包括词法、语法和语义。

词法规定了C语言中的标识符、关键字、运算符等的使用规则;语法规定了C语言程序的基本结构、语句、表达式的书写规则;语义规定了C语言程序的含义。

2. 预处理指令C语言的预处理指令包括#include、#define、#if、#else、#endif等。

这些指令可以在编译之前对程序进行一些处理,如包含头文件、定义常量、条件编译等。

3. 变量声明C语言要求在使用变量之前必须先声明。

声明可以是全局的或局部的,全局变量在整个程序中都可以使用,局部变量只能在定义它的函数中使用。

声明应该包括变量的类型、名称和作用域。

4. 函数定义C语言中的函数是一段可重用的代码块,可以完成特定的任务。

函数应该包括函数名、参数列表、返回类型和函数体。

函数参数列表包括参数类型和参数名,可以没有参数,也可以有多个参数。

返回类型指定了函数返回的值的数据类型。

5. 程序结构C语言的程序结构包括顺序结构、选择结构和循环结构。

顺序结构是程序按照代码顺序执行;选择结构包括if语句和switch语句,用于根据条件选择执行不同的代码块;循环结构包括for循环、while循环和do-while循环,用于重复执行一段代码。

6. 输入输出C语言提供了标准输入输出库stdio.h,包含了scanf和printf函数等输入输出函数。

scanf 函数可以从标准输入读取数据并赋值给变量,printf函数可以将数据输出到标准输出。

7. 错误处理C语言提供了异常处理机制,可以使用try-catch语句对程序中的错误进行处理。

try语句包含可能会抛出异常的代码块,catch语句包含处理异常的代码块。

当try语句中发生异常时,程序会跳转到catch语句中处理异常。

8. 内存管理C语言提供了内存管理函数,包括malloc、calloc和free等函数。

C语言格式书写要求规范

C语言格式书写要求规范

C语言书写规X指南第1章文件结构每个C程序通常分为两个文件。

一个文件用于保存程序的声明〔declaration〕,称为头文件。

另一个文件用于保存程序的实现〔implementation〕,称为定义〔definition〕文件。

C程序的头文件以“.h〞为后缀,C程序的定义文件以“.c〞为后缀。

和版本的声明位于头文件和定义文件的开头〔参见示例1-1〕,主要内容有:〔1〕信息。

〔2〕文件名称,标识符,摘要。

〔3〕当前版本号,作者/修改者,完成日期。

〔4〕版本历史信息。

/**Copyright(c)2001,某某大学物理学院无线电*Allrightsreserved.**文件名称:*文件标识:*摘要:简要描述本文件的内容**当前版本:* 输入作者〔或修改者〕名字*完成日期:2007年7月20日**取代版本:*原输入原作者〔或修改者〕名字*完成日期:2007年5月10日*/示例1-1和版本的声明头文件由三局部内容组成:〔1〕头文件开头处的和版本声明〔参见示例1-1〕。

〔2〕预处理块。

〔3〕函数和类结构声明等。

假设头文件名称为,头文件的结构参见示例1-2。

【规如此1-2-1】为了防止头文件被重复引用,应当用#ifndef/#define/#endif结构产生预处理块。

【规如此1-2-2】用#include<filename.h>格式来引用标准库的头文件〔编译器将从标准库目录开始搜索〕。

【规如此1-2-3】用#include“〞格式来引用非标准库的头文件〔编译器将从用户的工作目录开始搜索〕。

【规如此1-2-4】#include后面使用TAB键控制排版。

【规如此1-2-5】头文件中只存放“声明〞而不存放“定义〞【规如此1-2-6】全局变量在头文件中声明,在.c文件中定义.h externintvalue; 声明。

.c intvalue=0x10; 定义。

【规如此1-2-7】局部变量在.c中定义(static)unsigned intvalue; 定义。

c语言书写规则

c语言书写规则

c语⾔书写规则 从书写清晰,便于阅读,理解,维护的⾓度出发,在书写程序时应遵循以下规则: 1.⼀个说明或⼀个语句占⼀⾏。

2.⽤{} 括起来的部分,通常表⽰了程序的某⼀层次结构。

{}⼀般与该结构语句的第⼀个字母对齐,并单独占⼀⾏。

3.低⼀层次的语句或说明可⽐⾼⼀层次的语句或说明缩进若⼲格后书写。

以便看起来更加清晰,增加程序的可读性。

在编程时应⼒求遵循这些规则,以养成良好的编程风格。

1. 基本要求1.1 程序结构清析,简单易懂,单个函数的程序⾏数不得超过100⾏。

1.2 打算⼲什么,要简单,直接了当,代码精简,避免垃圾程序。

1.3 尽量使⽤标准库函数和公共函数。

1.4 不要随意定义全局变量,尽量使⽤局部变量。

1.5 使⽤括号以避免⼆义性。

2.可读性要求2.1 可读性第⼀,效率第⼆。

2.2 保持注释与代码完全⼀致。

2.3 每个源程序⽂件,都有⽂件头说明,说明规格见规范。

2.4 每个函数,都有函数头说明,说明规格见规范。

2.5 主要变量(结构、联合、类或对象)定义或引⽤时,注释能反映其含义。

2.7 常量定义(DEFINE)有相应说明。

2.8 处理过程的每个阶段都有相关注释说明。

2.9 在典型算法前都有注释。

2.10 利⽤缩进来显⽰程序的逻辑结构,缩进量⼀致并以Tab键为单位,定义Tab为 6个字节。

2.11 循环、分⽀层次不要超过五层。

2.12 注释可以与语句在同⼀⾏,也可以在上⾏。

2.13 空⾏和空⽩字符也是⼀种特殊注释。

2.14 ⼀⽬了然的语句不加注释。

2.15 注释的作⽤范围可以为:定义、引⽤、条件分⽀以及⼀段代码。

2.16 注释⾏数(不包括程序头和函数头说明部份)应占总⾏数的 1/5 到 1/3 。

3. 结构化要求3.1 禁⽌出现两条等价的⽀路。

3.2 禁⽌GOTO语句。

3.3 ⽤ IF 语句来强调只执⾏两组语句中的⼀组。

禁⽌ ELSE GOTO 和 ELSE RETURN。

3.4 ⽤ CASE 实现多路分⽀。

相关主题
  1. 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
  2. 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
  3. 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。

C++代码书写要求
1.基本要求
1.1 程序结构清析,简单易懂,单个函数的程序行数不得超过100行。

1.2 打算干什么,要简单,直接了当,代码精简,避免垃圾程序。

1.3 尽量使用标准库函数和公共函数。

1.4 不要随意定义全局变量,尽量使用局部变量。

1.5 使用括号以避免二义性。

2.可读性要求
2.1 可读性第一,效率第二。

2.2 保持注释与代码完全一致。

2.3 每个源程序文件,都有文件头说明,说明规格见规范。

2.4 每个函数,都有函数头说明,说明规格见规范。

2.5 主要变量(结构、联合、类或对象)定义或引用时,注释能反映其含义。

2.7 常量定义(DEFINE)有相应说明。

2.8 处理过程的每个阶段都有相关注释说明。

2.9 在典型算法前都有注释。

2.10 利用缩进来显示程序的逻辑结构,缩进量一致并以Tab键为单位,定义Tab为6个字节。

2.11 循环、分支层次不要超过五层。

2.12 注释可以与语句在同一行,也可以在上行。

2.13 空行和空白字符也是一种特殊注释。

2.14 一目了然的语句不加注释。

2.15 注释的作用范围可以为:定义、引用、条件分支以及一段代码。

2.16 注释行数(不包括程序头和函数头说明部份)应占总行数的1/5 到1/3 。

3. 结构化要求
3.1 禁止出现两条等价的支路。

3.2 禁止GOTO语句。

3.3 用IF 语句来强调只执行两组语句中的一组。

禁止ELSE GOTO 和ELSE RETURN。

3.4 用CASE 实现多路分支。

3.5 避免从循环引出多个出口。

3.6 函数只有一个出口。

3.7 不使用条件赋值语句。

3.8 避免不必要的分支。

3.9 不要轻易用条件分支去替换逻辑表达式。

4. 正确性与容错性要求
4.1 程序首先是正确,其次是优美
4.2 无法证明你的程序没有错误,因此在编写完一段程序后,应先回头检查。

4.3 改一个错误时可能产生新的错误,因此在修改前首先考虑对其它程序的影响。

4.4 所有变量在调用前必须被初始化。

4.5 对所有的用户输入,必须进行合法性检查。

4.6 不要比较浮点数的相等,
如:10.0 * 0.1 == 1.0 ,不可靠
4.7 程序与环境或状态发生关系时,必须主动去处理发生的意外事件,如文件能否
逻辑锁定、打印机是否联机等。

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

5. 可重用性要求
5.1 重复使用的完成相对独立功能的算法或代码应抽象为公共控件或类。

5.2 公共控件或类应考虑OO思想,减少外界联系,考虑独立性或封装性。

5.3 公共控件或类应建立使用模板。

6 程序编码要求
a. 程序编码力求简洁,结构清晰,避免太多的分支结构及太过于技巧性的程序,
尽量不采用递归模式。

b. 编写程序时,亦必须想好测试的方法,换句话说,”单元测试” 的测试方案应
在程序编写时一并拟好。

c. 注释一定要与程序一致。

d. 版本封存以后的修改一定要将老语句用/* */ 封闭,不能自行删除或修改,并要
在文件及函数的修改记录中加以记录。

e. 程序中每个block 的开头”{" 及"}” 必须对齐,嵌套的block 每进一套,
缩进一个tab,TAB 为4个空格,block类型包括if、for、while、do等关键字引出的。

f. 对于比较大的函数,每个block 和特殊的函数调用,都必须注明其功能,举例如下:
count.divisor = 1193280 / freq; // compute the proper count
OutByte((unsigned short)67, (unsigned char)182); // tell 8253 that a
count is coming
OutByte((unsigned short)66, count. c[0]); // send low-order byte
OutByte((unsigned short)66, count. c[1]); // send high-order byte。

相关文档
最新文档