c语言代码书写规范

合集下载

C语言代码规范

C语言代码规范

C语言代码规范C语言是一种广泛应用于编程领域的高级编程语言,具有跨平台、效率高、灵活性强等优点。

编写规范合乎标准的C语言代码有助于提高代码的可读性、可维护性和可移植性。

本文将介绍一些常用的C语言代码规范,以帮助开发者编写高质量的C语言程序。

一、代码格式1. 缩进:使用四个空格进行缩进,不要使用制表符。

这样可以保证在不同编辑器或显示器上显示的代码缩进一致。

2. 行长度限制:每行代码应尽量保持在80个字符以内,超过限制的代码可以进行适当换行。

换行时要注意保持代码的清晰可读性,一般可以采用缩进来表达代码的层次关系。

3. 大括号:大括号的位置应该和相关语句对齐,且起始的大括号应该放在语句所在行的末尾,而不是单独另起一行。

4. 空格和空行:在适当的情况下使用空格和空行可以提高代码的可读性。

例如,在运算符和操作数之间使用空格,不同的代码块之间使用空行进行分割等。

二、命名规范1. 变量名:使用有意义的变量名,尽量避免使用单个字符或简单的缩写表示变量。

变量名应该忠实地反映其所代表的含义。

2. 函数名:函数名应使用动词和名词的组合,具体描述函数的功能。

函数名应该清晰地表达其所完成的操作或所返回的结果。

3. 常量名:常量名使用全大写字母,并使用下划线进行分隔。

例如,MAX_LENGTH。

4. 类型名:类型名使用首字母大写的驼峰命名法,例如,StudentInfo。

5. 宏定义名:宏定义名使用全大写字母,并使用下划线进行分隔。

例如,PI。

三、注释规范1. 单行注释:使用"//"进行单行注释,注释符号后面应该留一个空格。

注释应该清晰明了,解释代码的用途或特殊处理等。

2. 多行注释:使用"/*"和"*/"进行多行注释。

多行注释通常用于解释一整块代码的功能或原理等。

3. 函数注释:在每个函数定义的上方加上函数注释,注释中应该包含函数的功能描述、输入参数的说明、返回值的含义以及可能抛出的异常等信息。

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语言编程的书写规则主要遵循以下规范:1. 缩进和空格:缩进和空格的使用可以使代码更易读。

通常,运算符两侧、逗号之后、控制语句(如if、for、while等)前后应添加空格。

在函数和括号的开头和结尾,通常应有空行。

2. 命名规则:变量和函数名应简洁且有意义。

通常,变量名和函数名以小写字母开头,后续单词的首字母大写,如 `myVariable`。

3. 注释:注释应简洁明了,解释代码的作用或目的,而不是解释代码是如何工作的。

注释应放在代码的上方或旁边,与代码保持一定距离。

4. 函数:函数应该尽可能短小,只做一件事情。

函数应具有描述性的名称,参数列表应清晰,并应包含返回类型。

5. 大括号:在C语言中,大括号 `{}` 用于定义代码块。

每一个独立的语句块都应该使用大括号。

6. 控制结构:控制结构(如if-else、for、while等)应该清晰明了,控制语句应只包含必要的逻辑。

7. 类型定义:类型定义应清晰明了,如果有必要,可以使用typedef来定义新的类型名称。

8. 预处理器指令:预处理器指令(如include、define等)应放在源文件的顶部。

9. 避免魔法数字和字符串:魔法数字和字符串(硬编码的值)会使代码难以理解和维护。

如果需要在代码中使用特定的值,应将其定义为常量或宏。

10. 避免全局变量:全局变量会使代码难以理解和维护,并可能导致意外的副作用。

尽可能使用局部变量。

11. 错误处理:在可能失败的操作后,应检查错误并相应地处理它们。

以上只是一些基本的C语言编程规则,实际编写代码时可能还需要考虑更多因素,如代码的可读性、可维护性、性能等。

C语言程序书写格式

C语言程序书写格式

C语言程序书写格式
C语言程序书写格式
引导语:为了增强C语言的可读性,正确的书写格式就显得十分重要。

以下是店铺分享给大家的'C语言程序书写格式,希望大家喜欢!
例.习分析下列程序的输出结果:
程序内容如下:
Multiply(x,
y)
int
x,y;return(x,Y);
}main (){
int a,
b;a=5}
B=6;printf(
”%d\n”,
multiply
(a,b)
);
)
读者一定会发现这个程序不容易读懂。

主要是书写上没有按照习惯的格式。

语言书写要求比较自由,一般只要一个单词不得分开写,单词之间用空白符分隔,而空白符包含空格符、水平制表符和换行符等。

因此,例1. 3中的程序书写上并没有词法错误。

执行该程序后,会在屏幕上显示出如下结果:
30
如果将该程序重新书写一遍,如下所示。

例1. 4〕将例1. 3程序重新书写如下:
rnultiply(x,y)
Int,x,y;
{
return(x * y);

main()
{
Int a,b;
printf ("%d\n" , multiply La, b)); 【C语言程序书写格式】。

C语言编程规范与风格

C语言编程规范与风格

C语言编程规范与风格C语言是一种广泛使用的编程语言,它的编程规范与风格对于保证代码的可读性、可维护性和可扩展性至关重要。

本文将介绍一些关键的C语言编程规范与风格,并提供一些实践建议。

1. 代码缩进代码缩进是C语言中非常重要的一个方面,它可以使代码结构清晰,易于阅读。

推荐使用4个空格或者制表符来进行代码缩进。

2. 命名规范为了让代码更易读和理解,命名规范应具有一定的规则性和描述性。

变量、函数和常量的命名应具有一定的规范,比如使用驼峰命名法(camelCase)或者下划线法(underscore_case)。

3. 注释注释是代码中的重要组成部分,可以使代码更易读和理解。

应该在代码中适当地使用注释,解释代码的功能、用途和注意事项。

注释应该清晰、简洁且易于理解。

4. 函数设计函数是C语言中重要的组织单元,应该遵循一定的设计原则来编写函数。

函数应该具有良好的命名,功能单一且高内聚。

函数的参数应该明确且合理,避免过多的参数传递。

函数的返回值应该清晰地说明其含义。

5. 条件语句和循环语句条件语句和循环语句是C语言中常用的流程控制语句,应该遵循一定的格式和风格。

条件语句的括号应该与关键字紧挨着,条件表达式应该适当地加上括号,以增加代码的可读性。

循环语句的条件表达式应该明确且易于理解,循环体应该具有合适的缩进。

6. 数据类型和变量声明在C语言中,数据类型和变量声明是非常重要的。

应该根据需要选择合适的数据类型,尽量避免使用过长或过短的数据类型。

变量声明应该在函数开头或者合适的位置进行,尽量避免使用全局变量。

7. 引入头文件C语言中的头文件对代码的模块化和可维护性非常重要。

在代码中应该适当引入所需要的头文件,避免使用过多的全局引入。

头文件应该具有合适的宏定义和条件编译,以提高代码的可复用性。

8. 错误处理在编程过程中,错误处理是非常重要的一部分。

应该养成检查错误和处理错误的习惯,合理运用条件语句和错误码,以便更好地调试和修复代码。

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语言的时候,第一步不是说要把程序写正确,而是要写规范。

因为如果你养成一种非常不好的写代码的习惯,代码就会写得乱七八糟,等到将来工作面试的时候,这样的习惯可能会让你失去机会。

那么代码如何写才能写得很规范呢?代码的规范化不是说看完本节内容后就能实现的。

它里面细节很多,而且需要不停地写代码练习,不停地领悟,慢慢地才能掌握的一种编程习惯。

所以大家不要想着一下子就能把代码规范化的所有知识全部掌握,也不要想着一下子就能把代码写规范,这是不太可能的。

有很多知识,比如为什么代码要这样写,为什么不能那样写,作为一个初学者你是很难弄明白的。

有很多规范是为了在程序代码量很大的时候,便于自己阅读,也便于别人阅读。

所以刚开始的时候有很多规范你不知道为什么要那样规定,你就单纯地模仿就行了。

等将来敲代码敲得时间长了,你就会感觉到那样写是很有好处的。

代码规范化的第一个好处就是看着很整齐、很舒服。

假如你现在用不规范的方式写了一万行代码,现在能看得懂,但等过了三个月你再回头看时就很吃力了,更不要说给别人看了。

所以代码要写规范,比如加注释就是代码规范化的一个思想。

在一般情况下,根据软件工程的思想,我们的注释要占整个文档的20%以上。

所以注释要写得很详细,而且格式要写得很规范。

第二个好处是,把代码写规范则程序不容易出错。

如果按照不规范的格式输入代码的话,很容易出错。

而代码写规范的话即使出错了查错也会很方便。

格式虽然不会影响程序的功能,但会影响可读性。

程序的格式追求清晰、美观,是程序风格的重要构成元素。

代码规范化基本上有七大原则,体现在空行、空格、成对书写、缩进、对齐、代码行、注释七方面的书写规范上。

c语言编程规范

c语言编程规范

c语言编程规范C语言编程规范(1000字)C语言作为一种广泛使用的编程语言,编写程序时应遵循一定的编程规范。

编程规范可以提高代码的可读性和维护性,减少错误和调试时间。

以下是一些常用的C语言编程规范。

1. 缩进和格式化:使用四个空格进行缩进,并在语句的开头和结尾留出适当的空格。

用大括号将代码块括起来,并将其包含的代码缩进四个空格。

例如:```cif (condition) {statement;}```2. 注释:对重要的代码块和函数进行注释,以便于其他开发人员阅读和理解代码。

注释应明确和简洁,并用英文书写。

例如:```c/* This function calculates the sum of two numbers */int sum(int a, int b) {return a + b;}```3. 命名规范:变量、函数和常量的命名应具有描述性,并使用小写字母和下划线分隔单词。

使用有意义的名称可以提高代码的可读性。

例如:```cint count; // 变量名用名词void print_hello(); // 函数名用动词const int MAX_LENGTH = 100; // 常量名全大写```4. 常量和宏定义:使用宏定义来定义常量和预处理指令,以便于代码维护和修改。

使用大写字母和下划线命名常量,并用宏定义来定义它们。

例如:```c#define MAX_LENGTH 100```5. 函数长度和复杂度:函数的长度应该控制在一定范围内,以提高代码的可读性和维护性。

通常推荐一个函数不超过30行代码,并且应该尽量避免过于复杂的控制流程。

如果一个函数超过了这个范围,可以考虑将其拆分为多个较小的函数。

6. 变量的声明和初始化:变量应在使用之前进行声明,并在声明时进行初始化。

声明时可以将相同类型的变量放在一起,并且可以将变量的声明放在函数体的开头。

例如:```cint main() {int foo, bar; // 变量声明int i = 0; // 变量声明和初始化...}```7. 错误处理:在编写代码时应该考虑错误处理。

c语言书写规则

c语言书写规则

c语言书写规则C语言是一门广泛应用于计算机编程领域的高级程序设计语言。

为了提高代码的可读性和可维护性,遵守规范的书写方式和规则是非常重要的。

本文将介绍C语言书写规则,以便程序员能够编写高质量的C代码。

一、命名规范在C语言中,命名是非常重要的。

良好的命名规范可以让代码更具可读性,并且遵循统一的命名约定可以减少混乱和错误。

以下是一些常见的命名规范:1.标识符应使用有意义的名称,能够清晰地表达其功能或作用。

2.变量名、函数名和常量名应使用小写字母,单词之间使用下划线分隔。

例如:count,print_value。

3.宏定义应全大写,并使用下划线分隔单词。

例如:MAX_VALUE。

4.结构体和枚举类型应使用首字母大写的驼峰命名法。

例如:StudentInfo,ColorType。

二、缩进和空格在C语言中,正确的缩进和空格使用可以使代码更易读和排版整洁。

1.使用一个制表符或者四个空格进行缩进,每一级缩进对应一个制表符或四个空格。

2.在运算符两侧和逗号后添加一个空格,以增加可读性。

例如:a =b + c。

3.在if、for、while等关键字后面和括号前后添加空格,以增强代码可读性。

例如:if (condition)。

三、注释规范注释是代码中重要的组成部分,它可以向其他开发者解释代码的功能和用途。

良好的注释规范可以提高代码的可维护性和可读性。

1.使用注释解释函数的作用、参数的含义、返回值等信息。

2.对于复杂的代码逻辑,使用注释进行说明和解释。

3.注释应与代码保持一致,不要出现拼写错误和过时的信息。

4.注释应该清楚简洁,不使用口头禅、行话或过度的翻译。

四、函数和变量函数和变量是C程序中最常用的元素,为了保持代码的一致性和可维护性,有一些规范需要遵守。

1.函数名应具有描述性,能够明确表达函数的功能和目的。

2.函数应尽量保持短小且功能单一,便于调试和维护。

3.变量应在使用前进行声明,并尽量在定义处进行初始化。

4.避免使用全局变量,因为它们会增加代码的复杂性和不可预测性。

C语言程序设计代码规范

C语言程序设计代码规范

C++语言程序设计代码规范1 命名规范本规范对变量、函数、类(结构)等的名称有严格的规定,在编码过程中务必遵守。

1.1 变量命名规范变量名称采用匈牙利命名法,即:完整的名称由“缀”和“主体”复合而成。

“缀”用于指示变量的种类、数值类型、作用域等属性,由小写字符和下划线(_)组成,根据其附着在“主体”的位置分为前缀和后缀两种。

“主体”表示变量的语义。

整个变量名称的格式如下:<作用域前缀>[<指针缀>]<类型缀><主体><作用域后缀>下面详细论述。

1.1.1 作用域缀(前缀和后缀)作用域前缀处在整个变量名的最前面。

常用的作用域前缀为:作用域后缀处在整个变量名的最后面。

只有一种情况使用作用域后缀,就是函数的形参必须以作用域后缀结束。

1.1.2 指针缀如果一个变量是指针,则必须使用指针缀。

指针缀使用字母p表示。

以前,在DOS平台下有短指针和长指针的区别,有时称长指针为lp。

在Win32平台下已经不存在这个区别了,所以统一使用p, 而不是lp。

1.1.3 类型缀类型缀由小写字符构成,用于描述变量的类型。

注意:1.不要私自创造出各种各样的前缀。

2.也没有必要在前缀中仔细区分一些细小的类型区别,那样会给代码维护工作带来额外的麻烦。

常用的类型前缀为:对于其他不在上面表中的结构、类等复杂数据类型,特别是不常使用的和不通用的,不使用前缀。

例如:class Person Jonson;struct DateTime MyDt;在应用场合明确的情况下,例如:简单的局部变量,它的值类型前缀有时可以省略。

具体见下面的例子。

1.1.4 复合前缀根据以上规则,变量根据它所在的作用域、类型、是否是指针,得到一个复合前缀。

例如:char g_szFileName[_MAX_PATH]; //全局字符串变量char* g_pszFileName; //全局字符串指针变量:char s_szFileName[_MAX_PATH]; //静态字符串变量char* s_pszFileName; //静态字符串指针变量:char _s_szFileName[_MAX_PATH]; //局部静态字符串变量char* _s_pszFileName; //局部静态字符串指针变量:char m_szFileName[_MAX_PATH]; //类字符串变量char* m_pszFileName; //类字符串指针变量:char ms_szFileName[_MAX_PATH]; //类静态字符串变量char* ms_pszFileName; //类静态字符串指针变量:更多的例子,参见下面按照作用域讨论变量名一节。

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语言书写格式概述C语言是一种广泛使用的编程语言,它具有简洁、易读、灵活和高效等优点,被广泛应用于系统编程、嵌入式系统开发、数据结构和算法实现等领域。

在书写C语言代码时,需要注意一些基本的格式规范,以确保代码的可读性和可维护性。

下面将对C语言的书写格式进行简要的介绍。

代码缩进和空格C语言是一种依赖于空格和缩进来组织代码结构的编程语言,因此,正确地使用缩进和空格是非常重要的。

一般来说,每个缩进级别应该使用4个空格,这样可以清晰地分隔出代码的不同部分,方便阅读和理解。

同时,在编写代码时,应该使用空格来分隔变量、运算符和函数调用等元素,以提高代码的可读性。

注释和文档字符串注释是代码的重要组成部分,可以帮助程序员理解代码的功能和实现方式。

在C语言中,可以使用单行注释和多行注释来对代码进行解释和说明。

一般来说,应该为重要的函数和复杂的代码段添加注释,以便其他开发人员能够理解代码的功能和工作原理。

此外,还应该使用文档字符串(docstring)来描述函数的用途和参数说明,以提高代码的可维护性。

变量命名规范变量命名是编程中非常重要的一个方面,它应该具有描述性并且易于阅读。

在C语言中,变量名应该遵循一定的命名规范,如使用小写字母和下划线,避免使用单个字符作为变量名等。

同时,变量名应该具有描述性,能够清晰地表达变量的含义和用途。

函数定义格式函数是C语言中的基本构造之一,它可以将相关的代码组织在一起,提高代码的可读性和可维护性。

在定义函数时,应该遵循一定的格式规范,如使用正确的函数声明格式、参数列表和返回值类型等。

此外,还应该为函数添加注释,说明函数的用途、输入参数和返回值等信息。

控制结构书写规范在C语言中,控制结构是用来组织和控制代码的关键部分。

常见的控制结构包括if语句、switch语句、循环结构和函数调用等。

在书写这些控制结构时,应该遵循一定的规范,如使用括号来包裹表达式和分支语句、正确使用break和continue语句等。

初识C语言编码规范

初识C语言编码规范

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

每行不超过80字符。

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

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

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

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

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

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

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

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

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

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

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

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

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

c语言编程规范

c语言编程规范

c语言编程规范C语言编程规范是指在使用C语言进行编程时应该遵循的一系列规定和标准。

在编写C语言程序时,遵循统一的编程规范可以提高代码的可读性、可维护性、可移植性和可靠性。

下面是一些常见的C语言编程规范,供大家参考和遵循。

1. 命名规范在C语言中,变量、函数、常量、宏等的命名应具有一定的规范性,以方便他人理解和阅读代码。

一般来说,命名应该尽量做到以下几点:- 变量和函数名使用小写字母,如果是多个单词组成,可以使用下划线 `_` 进行连接,如 `my_variable`。

- 宏常量使用全大写字母,并使用下划线 `_` 进行连接,如`MAX_SIZE`。

- 类型名和结构体名使用首字母大写的驼峰命名法,如 `MyStruct`。

- 全局变量和静态变量以 `g_` 开头,如 `g_count`。

- 局部变量使用有意义的名词或者简洁明了的单词缩写,如 `i` 表示整数变量,`ptr` 表示指针变量等。

2. 缩进与对齐在书写代码时,正确的缩进和对齐可以提高代码的可读性,让代码结构更加清晰。

通常使用4个空格进行缩进,并且在各个代码块之间使用空行进行分隔。

3. 注释规范注释是代码中必不可少的一部分,它可以解释代码的功能、逻辑和用法,便于其他人阅读和理解。

在编写注释时应尽量做到以下几点:- 使用自然语言进行注释,注释的内容要清晰明了,让其他开发人员容易理解。

- 对于复杂的逻辑或者算法,可以在代码旁边用注释进行解释。

- 对于不常见的技术或者特殊情况,可以在代码中加上注释进行说明。

- 尽量避免使用废弃的注释,及时更新和维护注释。

4. 函数规范函数是程序中的基本组成单元,编写规范的函数可以提高代码的可读性和可维护性。

在编写函数时应尽量做到以下几点:- 函数应该有明确的功能和目的,并且函数名要能够准确反映其功能。

- 函数的参数应该尽量避免过多,如果参数较多,可以考虑使用结构体传递参数。

- 函数应该尽量遵循单一职责原则,即一个函数只完成一个功能。

华为c语言编程规范

华为c语言编程规范

华为c语言编程规范华为C语言编程规范1. 命名规范:- 变量、函数、宏名使用小写字母和下划线的组合,如:int my_variable;- 宏名全部大写,并用下划线分隔单词,如:#defineMAX_NUM 100;- 结构体命名使用大驼峰命名法,如:typedef struct MyStruct; - 文件名使用小写字母和下划线的组合,如:my_file.c;2. 缩进与换行:- 使用4个空格进行缩进,不使用Tab键;- 换行时,尽量将操作符放在新行开头,如:a = b +c;- if、for、while等关键字后的括号与关键字之间不换行;- 如果一行超过80个字符,应该进行换行;3. 注释规范:- 使用//进行单行注释;- 使用/**/进行多行注释;- 对代码的重点或逻辑进行注释,并保持注释和代码同步更新;- 不使用无意义的注释;4. 函数与变量规范:- 函数应该具有明确的功能,并使用动词开头;- 变量必须在使用前进行声明,并尽量减少全局变量的使用; - 变量名应该具有描述性,并易于理解;- 不要使用具有歧义或过于简单的变量名;- 变量应该在定义的同时初始化;5. 语法与逻辑规范:- 不要在一个语句中定义多个变量;- 避免使用goto语句;- 比较变量和常量时,应该将变量放在前面,如:if (x == 0); - 不要使用宏定义来替换函数,除非替换后代码不被执行;- 返回值应该使用明确的类型,避免使用int类型表示布尔值; - 使用语言提供的错误处理机制,不要使用全局变量进行错误处理;6. 引入外部文件规范:- 头文件的引用应该尽可能放在源文件的开头;- 头文件的引用应该使用""而不是<>,以示区分;- 头文件的引用应该避免循环引用;- 不要在头文件中定义变量;以上是华为C语言编程规范的部分内容,为了提高代码的可读性和可维护性,开发者应该严格遵守这些规范。

这些规范不仅适用于华为的开发项目,也适用于其他的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++语言中括号已经是最清晰的标志了。 在长语句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部不加空格。给操作符留空格时不要连续留两个以上空格。
  1. 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
  2. 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
  3. 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。

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等关键字之后应留一个空格再跟左括号‘(’,以突出关键字。

? 【规则】函数名之后不要留空格,紧跟左括号‘(’,以与关键字区别。

? 【规则】‘(’向后紧跟,‘)’、‘,’、‘;’向前紧跟,紧跟处不留空格。

? 【规则】‘,’之后要留空格,如Function(x, y, z)。

如果‘;’不是一行的结束符号,其后要留空格。

? 【规则】赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符,如“=”、“+=”“>=”、“? 【规则】一元操作符如“!”、“~”、“++”、“--”、“&”(地址运算符)等前后不加空格。

? 【规则】象“[]”、“.”、“->”这类操作符前后不加空格。

? 【建议】对于表达式比较长的for语句和if语句,为了紧凑可以适当地去掉一些空格,如for (i=0; i ? 【规则】程序的分界符‘{’和‘}’应独占一行并且位于同一列,同时与引用它们的语句左对齐。

? 【规则】{ }之内的代码块在‘{’右边数格处左对齐。

长行拆分? 【规则】代码行最大长度宜控制在70至80个字符以内。

代码行不要过长,否则眼睛看不过来,也不便于打印。

? 【规则】长表达式要在低优先级操作符处拆分成新行,操作符放在新行之首(以便突出操作符)。

拆分出的新行要进行适当的缩进,使排版整齐,语句可读。

注释? 注释符为“/*?*/”。

C++语言中,程序块的注释常采用“/*?*/”,行注释一般采用“//?”。

注释通常用于:版本、版权声明;函数接口说明;重要的代码行或段落提示。

? 【规则】注释是对代码的“提示”,而不是文档。

程序中的注释不可喧宾夺主,注释太多了会让人眼花缭乱。

注释的花样要少。

? 【规则】如果代码本来就是清楚的,则不必加注释。

否则多此一举,令人厌烦。

例如 i++; // i加 1,多余的注释? 【规则】边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。

不再有用的注释要删除。

? 【规则】注释应当准确、易懂,防止注释有二义性。

错误的注释不但无益反而有害。

? 【规则】尽量避免在注释中使用缩写,特别是不常用缩写。

? 【规则】注释的位置应与被描述的代码相邻,可以放在代码的上方或右方,不可放在下方。

? 【规则】当代码比较长,特别是有多重嵌套时,应当在一些段落的结束处加注释,便于阅读。

三、命名规则共性规则? 【规则】标识符应当直观且可以拼读,可望文知意,不必进行“解码”。

? 标识符最好采用英文单词或其组合,便于记忆和阅读。

切忌使用汉语拼音来命名。

程序中的英文单词一般不会太复杂,用词应当准确。

例如不要把CurrentValue写成NowValue。

? 【规则】标识符的长度应当符合“min-length && max-information”原则。

? 【规则】命名规则尽量与所采用的操作系统或开发工具的风格保持一致。

例如Windows应用程序的标识符通常采用“大小写”混排的方式,如AddChild。

而Unix应用程序的标识符通常采用“小写加下划线”的方式,如add_child。

别把这两类风格混在一起用。

? 【规则】程序中不要出现仅靠大小写区分的相似的标识符。

? 【规则】程序中不要出现标识符完全相同的局部变量和全局变量,尽管两者的作用域不同而不会发生语法错误,但会使人误解。

? 【规则】变量的名字应当使用“名词”或者“形容词+名词”。

? 【规则】全局函数的名字应当使用“动词”或者“动词+名词”(动宾词组)。

类的成员函数应当只使用“动词”,被省略掉的名词就是对象本身。

? 【规则】用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。

? 【建议】尽量避免名字中出现数字编号,如Value1,Value2等,除非逻辑上的确需要编号。

这是为了防止程序员偷懒,不肯为命名动脑筋而导致产生无意义的名字(因为用数字编号最省事)。

简单的Windows应用程序命名规则? 【规则】类名和函数名用大写字母开头的单词组合而成。

? 【规则】变量和参数用小写字母开头的单词组合而成。

? 【规则】常量全用大写的字母,用下划线分割单词。

? 【规则】静态变量加前缀s_(表示static)。

? 【规则】如果不得已需要全局变量,则使全局变量加前缀g_(表示global)。

? 【规则】类的数据成员加前缀m_(表示member),这样可以避免数据成员与成员函数的参数同名。

? 【规则】为了防止某一软件库中的一些标识符和其它软件库中的冲突,可以为各种标识符加上能反映软件性质的前缀。

例如三维图形标准OpenGL的所有库函数均以gl开头,所有常量(或宏定义)均以GL开头。

表达式和基本语句? 规则】如果代码行中的运算符比较多,用括号确定表达式的操作顺序,避免使用默认的优先级。

复合表达式? 【规则】不要编写太复杂的复合表达式。

? 【规则】不要有多用途的复合表达式。

? 【规则】不要把程序中的复合表达式与“真正的数学表达式”混淆。

if 语句? 布尔变量与零值比较【规则】不可将布尔变量直接与TRUE、FALSE或者1、0进行比较。

【规则】应当将整型变量用“==”或“!=”直接与0比较。

【规则】不可将浮点变量用“==”或“!=”与任何数字比较。

【规则】应当将指针变量用“==”或“!=”与NULL比较。

? 整型变量与零值比较 ? 浮点变量与零值比较 ? 指针变量与零值比较? 有时候我们可能会看到 if (NULL == p) 这样古怪的格式。

不是程序写错了,是程序员为了防止将 if (p == NULL) 误写成 if (p = NULL),而有意把p和NULL颠倒。

编译器认为 if (p = NULL) 是合法的,但是会指出 if (NULL = p)是错误的,因为NULL不能被赋值。

循环语句的效率? 【建议】在多重循环中,如果有可能,应当将最长的循环放在最内层,最短的循环放在最外层,以减少CPU跨切循环层的次数。

? 【建议】如果循环体内存在逻辑判断,并且循环次数很大,宜将逻辑判断移到循环体的外面。

for 语句的循环控制变量? 【规则】不可在for 循环体内修改循环变量,防止for 循环失去控制。

? 【建议】建议for语句的循环控制变量的取值采用“半开半闭区间”写法。

四、函数设计参数的规则? 【规则】参数的书写要完整,不要贪图省事只写参数的类型而省略参数名字。

如果函数没有参数,则用void 填充。

? 【规则】参数命名要恰当,顺序要合理。

? 【规则】如果参数是指针,且仅作输入用,则应在类型前加const,以防止该指针在函数体内被意外修改。

? 【规则】如果输入参数以值传递的方式传递对象,则宜改用“const &”方式来传递,这样可以省去临时对象的构造和析构过程,从而提高效率。

? 【建议】避免函数有太多的参数,参数个数尽量控制在5个以内。

如果参数太多,在使用时容易将参数类型或顺序搞错。

? 【建议】尽量不要使用类型和数目不确定的参数。

返回值的规则? 【规则】不要省略返回值的类型。

? 【规则】函数名字与返回值类型在语义上不可冲突。

? 【规则】不要将正常值和错误标志混在一起返回。

正常值用输出参数获得,而错误标志用return语句返回。

? 【建议】有时候函数原本不需要返回值,但为了增加灵活性如支持链式表达,可以附加返回值。

? 【建议】如果函数的返回值是一个对象,有些场合用“引用传递”替换“值传递”可以提高效率。

而有些场合只能用“值传递”而不能用“引用传递”,否则会出错。

函数内部实现的规则? 【规则】在函数体的“入口处”,对参数的有效性进行检查。

? 【规则】在函数体的“出口处”,对return语句的正确性和效率进行检查。

其它建议? 【建议】函数的功能要单一,不要设计多用途的函数。

? 【建议】函数体的规模要小,尽量控制在50行代码之内。

? 【建议】尽量避免函数带有“记忆”功能。

相同的输入应当产生相同的输出。

建议尽量少用static局部变量,除非必需。

? 【建议】不仅要检查输入参数的有效性,还要检查通过其它途径进入函数体内的变量的有效性,例如全局变量、文件句柄等。

? 【建议】用于出错处理的返回值一定要清楚,让使用者不容易忽视或误解错误情况。

五、内存管理内存分配方式? 内存分配方式有三种:从静态存储区域分配。

内存在程序编译的时候就已经分配好,这块内存在程序的整个运行期间都存在。

例如全局变量,static变量。

在栈上创建。

在执行函数时,函数内局部变量的存储单元都可以在栈上创建,函数执行结束时这些存储单元自动被释放。

栈内存分配运算内置于处理器的指令集中,效率很高,但是分配的内存容量有限。

从堆上分配,亦称动态内存分配。

程序在运行的时候用malloc或new申请任意多少的内存,程序员自己负责在何时用free或delete释放内存。

动态内存的生存期由我们决定,使用非常灵活,但问题也最多。

常见的内存错误及其对策? 内存分配未成功,却使用了它。

常用解决办法是,在使用内存之前检查指针是否为NULL? 内存分配虽然成功,但是尚未初始化就引用它。

两个起因:一是没有初始化的观念;二是误以为内存的缺省初值全为零。

? 内存分配成功并且已经初始化,但操作越过了内存的边界。

相关文档
最新文档