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语言中不遵守编译器的规定,编译器在编译时就会报错,这个规定叫作规则。

但是有一种规定,它是一种人为的、约定成俗的,即使不按照那种规定也不会出错,这种规定就叫作规范。

虽然我们不按照规范也不会出错,但是那样代码写得就会很乱。

大家刚开始学习C语言的时候,第一步不是说要把程序写正确,而是要写规范。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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语言编程规范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 改一个错误时可能产生新的错误,因此在修改前首先考虑对其它程序的影响。

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语言代码编写C语言代码是程序员的基本技能之一。

无论是初学者还是有经验的开发者,都需要掌握一些编写C语言代码的基本规范和技巧。

本文将介绍一些编写C语言代码的方法和注意事项,帮助读者更好地编写高质量的C语言代码。

一、选择适当的开发环境在开始编写C语言代码之前,首先需要选择一个适合的开发环境。

目前比较常用的C语言开发环境有Visual Studio、Code::Blocks、Eclipse等。

根据自己的喜好和需要选择一个方便易用的开发环境,并安装相应的编译器和调试工具。

二、了解C语言的基本语法和规范编写C语言代码前,必须了解C语言的基本语法和规范。

C语言是一种结构化编程语言,具有严格的语法要求。

一些基本的语法规则包括:1. 变量的声明:在使用变量之前,需要先声明变量的类型和名称。

例如:int num;2. 语句的结束:每条语句必须以分号";"作为结束符。

例如:printf("Hello, World!");3. 函数的定义:C语言是通过函数来组织代码的,每个程序至少包含一个main函数。

例如:int main() { // 函数体 }4. 注释的使用:注释可以增加代码的可读性,以"//"表示单行注释,以"/*...*/"表示多行注释。

例如:// 这是一个注释。

三、遵循良好的编码风格编写C语言代码时,应遵循统一的编码风格,以增加代码的可读性和可维护性。

一些常见的编码风格规范包括:1. 使用有意义的变量和函数名:变量和函数名应该具有描述性,能够清楚地表达其用途。

例如:int count = 0;2. 缩进:使用适当的缩进来组织代码,使代码结构清晰。

一般推荐使用4个空格或者一个制表符作为缩进。

3. 换行和空格:合理使用换行和空格,以增加代码的可读性。

例如,将长的语句或者表达式分成多行。

4. 注释:使用注释来说明代码的意图和逻辑,提高代码的可读性。

C语言编程规范标准

C语言编程规范标准

编码规1. 头文件编码规 (2)2. 函数编写规 (2)3. 标识符命名与定义 (2)3.1通用命名规则 (2)3.2 变量命名规则 (3)3.3函数命名规则 (3)3.4 宏的命名规则 (3)4. 变量 (3)5. 宏、常量 (4)6. 质量保证 (4)7. 程序效率 (5)8. 注释 (5)9. 排版与格式 (6)10. 表达式 (7)11. 代码编辑、编译 (7)12. 安全性 (7)13. 可读性 (7)14. 可测性 (7)15. 单元测试 (8)16. 可移植性 (8)1. 头文件编码规1. 禁止头文件循环依赖。

2. .c/.h文件不要包含用不到的头文件。

3. 禁止在头文件中定义变量。

4. 同一产品统一包含头文件排列方式。

(如功能块排序、文件名升序、稳定度排序。

)5. 只能通过包含头文件的方式使用其他.c提供的接口,禁止在.c过extern的方式使用外部函数接口、变量。

2. 函数编写规1. 一个函数仅完成一件功能。

2. 重复代码应该尽可能提炼成函数。

3.为简单功能编写函数4.函数的返回值要清楚、明了,让使用者不容易忽视错误情况。

5. 避免函数过长,新增函数不超过100行(非空非注释行)。

6. 避免函数的代码块嵌套过深,新增函数的代码块嵌套不超过4层。

7. 可重入函数应避免使用全局变量和禁止使用static变量。

8. 设计高扇入,合理扇出(小于7)的函数。

9. 废弃代码(没有被调用的函数和变量)要及时注释(有助于更好理解程序)。

10. 对所调用函数的错误返回码要仔细、全面地处理。

11. 函数不变参数使用const。

12. 函数应避免使用全局变量、静态局部变量和I/O操作,不可避免的地方应集中使用。

13. 函数的参数个数不超过5个。

14. 减少或禁止函数本身或函数间的递归调用3. 标识符命名与定义3.1通用命名规则1. 标识符的命名要清晰、明了,有明确含义,同时使用完整的单词或大家基本可以理解的缩写,避免使人产生误解。

华为CC语言编程规范

华为CC语言编程规范

百度文库- 让每个人平等地提升自我目录1 排版 (2)4 可读性 (11)6 函数、过程 (13)7 可测性 (14)1 排版¹1-1:程序块要采用缩进风格编写,缩进的空格数为4个。

说明:对于由开发工具自动生成的代码可以有不一致。

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

示例:如下例子不符合规范。

if (!valid_ni(ni)){... epssn_index;repssn_ni = ssn_data[index].ni;应如下书写if (!valid_ni(ni)){... epssn_index;repssn_ni = ssn_data[index].ni;¹1-3:较长的语句(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。

示例:= NO7_TO_STAT_PERM_COUNT_LEN+ STAT_SIZE_PER_FRAM * sizeof( _UL );act_task_table[frame_id * STAT_TASK_CHECK_NUMBER +index].occupied= stat_poi[index].occupied;act_task_table[taskno].duration_true_or_false= SYS_get_sccp_statistic_state( stat_item );report_or_not_flag = ((taskno < MAX_ACT_TASK_NUMBER)&& (n7stat_stat_item_valid (stat_item)) &&(act_task_table[taskno].result_data != 0));¹1-4:循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首。

  1. 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
  2. 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
  3. 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
– 实在太长时要在适当位置拆分,拆分出的新行要进行适当缩进
if ((veryLongVar1 >= veryLongVar2) &&(veryLongVar3 >= veryLongVar4)) { DoSomething(); } double FunctionName(double variablename1, double variablename2); for (very_longer_initialization; very_longer_condition; very_longer_update) { DoSomething(); }
代码规范
rules and guidelines of Coding Style
关于代码风格问题
代码风格(Coding Style)是一种习惯 – 现在许多大公司都对员工书写代码制定了规范 – 开发大项目时由项目管理者制定代码规范 Basic rules and guidelines of Coding Style – 程序版式 – 程序注释 – 命名规则 Some other rules and guidelines of Coding Style 内存管理

2015-4-11
21
Windows应用程序命名规则
Microsoft公司的Hungarian Notation(匈牙利命名法) 主要思想 – 在变量和函数名前加上前缀,用于标识变量的数据类型 – [限定范围的前缀] + [数据类型前缀] + [有意义的英文单词] – 限定范围的前缀

{和}独占一行,且位于同一列,与引用它们的语句左对齐, 便于检查配对情况
– 位于同一层{和}之内的代码在{右边数格处左对齐,
即同层次的代码在同层次的缩进层上 – 可以用设置为4个空格的Tab键缩进,也可以空格缩进
2015-4-11
6
建议的风格
void Function(int x) { … // program code } if (condition) { … // program code } else { … // program code } for (initialization; condition; update) { … // program code } while (condition) { … // program code } 如果出现嵌套的{},则使用缩进对齐,如 : { … { … } … 2015-4-11 }
2015-4-11
4
程序版式

良好的风格
int isprime(int n) { int k, i; if (n == 1) return 0; k = (int)sqrt((double)n); for (i=2; i<=k; i++) { if (n % i == 0) return 0; } return 1; }



静态变量前加前缀s_ ,表示static 全局变量前加前缀g_ ,表示global 类内的成员函数m_ 默认情况为局部变量
20
2015-4-11
标识符命名的共性规则

尽量与所采用的操作系统或开发工具的风格保持 一致 – 在Linux/Unix平台

习惯用“小写加下划线” function_name variable_Name 大小写混排的单词组合而成 FunctionName variableName
– Windows风格

代码行 – 一行只写一条语句,这样方便测试 – 一行只写一个变量,这样方便写注释
int int int

width; height; depth; sum = 0;
//宽度 //高度 //深度
– 尽可能在定义变量的同时,初始化该变量
int
– if、for、while、do等语句各占一行,执行语句无论有几条都用
x, y; *x, y;
– 提倡靠近变量名

2015-4-11
16
类的版式

“以数据为中心”的版式 – private类型的数据写在前面,public类型的数据
写在后面 – 关注类的内部结构

“以行为为中心”的版式 – public类型的数据写在前面, private类型的数
据写在后面 – 关注的是类应该提供什么样的接口(或服务)
x = a + b;
y = c + d;
z = e + f;
if (width < height) dosomething();
for (initialization; condition; update) dosomething(); other();
2015-拆分 – 代码行不宜过长,应控制在10个单词或70-~80个字符以内

2015-4-11
2
程序版式

程序版式——程序员的书法 – 比书法好学得多,基本不需要特别练习

但是坏习惯一旦养成,就像书法一样难以改变
不影响程序的功能,但影响程序的可读性 追求 – 清晰、整洁、美观、一目了然 – 容易阅读,容易测试

2015-4-11
3
程序版式

不良的风格
#include <stdio.h> #include <math.h>

提倡后者 – 因为用户最关心的是接口
17
2015-4-11
标识符命名规则
大连大有吴涛公司的易语言 – 变量名和函数名都用汉字 日本在VC基础上开发的语言Holon – 变量名和函数名都用日文假名

2015-4-11
18
标识符命名规则

按照执行级别分为: – 共性规则

必须执行
– 简化规则


– [] . -> 前后不加空格 – 对表达式较长的for和if语句,为了紧凑可在适当地方去掉一些空格
for (i=0; i<10; i++) if ((a+b>c) && (b+c>a) && (c+a>b))

2015-4-11 11
程序版式
void Func1(int x, int y, int z); void Func1 (int x,int y,int z); printf("%d%d%d", a, b, c); printf("%d%d%d",a,b,c); if (year >= 2000) if(year>=2000) if ((a>=b) && (c<=d)) if(a>=b&&c<=d) for (i=0; i<10; i++) for(i=0;i<10;i++) for (i = 0; i < 10; i ++) x = a < b ? a : b; x=a<b?a:b; int *x = &y; int * x = & y; array[5] = 0; a.Function(); b->Function(); // 良好的风格 // 不良的风格 // // // // // // 良好的风格 不良的风格 良好的风格 不良的风格 良好的风格 不良的风格
不建议的风格
void Function(int x){ … // program code }
if (condition){ … // program code } else { … // program code } for (initialization; condition; update){ … // program code } while (condition){ … // program code }
建议采用
灵活运用
– 可选规则

2015-4-11
19
标识符命名的共性规则





直观可以拼读,见名知意,不必解码 最好采用英文单词或其组合,切忌用汉语拼音 尽量避免出现数字编号 不要出现仅靠大小写区分的相似的标识符 不要出现名字完全相同的局部变量和全局变量 用正确的反义词组命名具有互斥意义的变量或相反 动作的函数 – int minValue; – int maxValue; – int GetValue(…); – int SetValue(…);
main() {int i; for (i=2;i<100;i++) {if(isprime(i)) printf("%d\t",i); } } int isprime(int n) {int k,i; if (n == 1) return 0; k=sqrt((double)n); for (i=2;i<=k;i++) {if(n%i==0) return 0;} return 1; }
// 良好的风格 // 不良的风格 // 过多的空格 // 良好的风格 // 不良的风格 // 良好的风格 // 不良的风格 // 不要写成 array [ 5 ] = 0; // 不要写成 a . Function(); // 不要写成 b -> Function();
2015-4-11
12
程序版式
{和}将其包含在内,这样便于维护
if (width < height) { DoSomething(); } //空行 OtherThing();
2015-4-11 13
程序版式
相关文档
最新文档