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语言代码的安全性,开发人员需要遵循一定的编码规范和最佳实践。

本文将介绍一些C语言中相关的安全性代码编码规范与最佳实践,以帮助开发人员编写更加安全的代码。

1. 输入验证在C语言中,输入验证是确保代码安全性的关键步骤之一。

开发人员应该始终验证用户输入,以避免潜在的安全漏洞。

以下是一些常见的输入验证措施:1.1 长度验证:验证用户输入的长度是否符合预期,防止缓冲区溢出的风险。

1.2 类型验证:确保用户输入的数据类型与预期类型相匹配,防止类型转换错误。

1.3 格式验证:针对特定的输入数据格式进行验证,例如邮箱、电话号码等。

2. 内存安全在C语言中,内存安全是一个常见的安全隐患。

通过以下措施,可以减少内存安全问题的发生:2.1 使用安全的库函数:C语言提供了一系列安全的库函数,如strcpy_s和strcat_s等,用于替代不安全的函数,如strcpy和strcat,以减少缓冲区溢出的风险。

2.2 动态内存分配与释放:在使用动态内存分配函数(如malloc和free)时,务必注意正确释放内存,防止内存泄漏。

3. 错误处理与日志记录良好的错误处理和日志记录机制对于代码的安全性至关重要。

以下是一些建议:3.1 错误码检查:在调用可能返回错误码的函数后,应该始终检查其返回值,以及时处理异常情况。

3.2 异常处理:使用try-catch块或其他异常处理机制来捕获和处理可能发生的异常,以避免程序崩溃或信息泄漏。

3.3 日志记录:记录错误、警告和其他重要事件,以便及时排查问题并提供追踪。

4. 密码存储与加密在处理用户密码等敏感信息时,开发人员应特别注意其存储和传输的安全性。

以下是一些建议:4.1 密码加密:使用安全的加密算法对敏感信息进行加密,如SHA-256或AES。

4.2 密码哈希:对密码进行哈希处理,并采用适当的哈希算法,如bcrypt或PBKDF2,以防止密码泄露。

c语言代码规范

c语言代码规范

c语言代码规范C语言是一种通用的编程语言,广泛应用于嵌入式系统、操作系统、驱动程序以及各种应用程序的开发中。

为了提高代码的可读性、可维护性和可移植性,制定一套严格的代码规范是非常必要的。

1. 缩进与空格:- 使用4个空格进行缩进,不要使用Tab键。

- 在运算符两侧以及逗号后加上一个空格。

2. 命名规范:- 变量、函数和类型的命名采用小驼峰命名法,例如myVariable。

- 全局变量以g_开头,静态变量以s_开头。

- 宏定义全部大写,并用下划线分隔单词。

3. 函数定义:- 函数名应该能够描述函数的功能。

- 函数名应该以动词开头,使用小驼峰命名法。

- 函数的参数列表应该明确指明参数的类型和名称。

4. 注释:- 在每个函数之前添加简要的注释,说明函数的功能、参数和返回值。

- 在复杂的代码块中添加必要的注释,解释代码的逻辑和目的。

5. 头文件:- 头文件应该包含必要的宏定义、类型定义和函数声明,不要包含具体的函数实现。

- 头文件应该有相应的宏定义来防止多次包含。

6. 文件结构:- 文件应该按照功能模块进行组织,每个功能模块放在一个独立的文件中。

- 文件中的代码应该按照逻辑顺序进行排列,函数之间使用空行进行分隔。

7. 魔法数值:- 不要直接在代码中出现魔法数值,应该使用常量或者宏来表示。

- 大多数情况下,常量应该在文件的头部定义,并加上相应的注释。

8. 错误处理:- 对于可能出现错误的函数调用,应该检查返回值并进行相应的错误处理。

- 错误处理可以是返回特定的错误码或者抛出异常,但应该保持一致。

9. 括号和空行:- 括号应该与控制语句在同一行,并在括号内留出空格。

- 在函数和控制语句之间应该使用适当的空行进行分隔,提高可读性。

10. 可移植性:- 不要使用与平台相关的特性或者语法。

- 使用标准的数据类型和函数接口,避免使用非标准扩展。

- 避免使用与编译器相关的优化选项。

以上是一些常用的C语言代码规范,可以根据具体的项目需求进行适当调整。

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语言编程规范与代码Review

C语言编程规范与代码Review

C语言编程规范与代码Review C语言是一门广泛使用的编程语言,为了保证程序的可读性、可维护性和可移植性,编程人员需要遵守一定的编程规范。

本文将介绍一些常见的C语言编程规范,并讨论代码Review的重要性和方法。

一、命名规范在C语言编程中,合适的命名规范能够使程序更易读懂。

以下是一些常见的命名规范建议:1. 变量命名应具有描述性,能够清晰表达其用途;2. 使用有意义的函数名,能够准确表达函数的功能;3. 使用驼峰命名法或下划线命名法,保持命名的一致性;4. 避免使用单字符作为变量名或函数名,除非其在特定情况下具有明确含义。

二、缩进与对齐缩进和对齐是保持代码结构清晰的重要手段。

在C语言编程中,以下规则需要注意:1. 使用适当的缩进来区分不同层次的代码块;2. 使用合适的空格或制表符对齐代码,使其更易读;3. 在函数定义和条件语句等代码块中,使用花括号将其包裹起来,保持结构的清晰性。

三、注释规范良好的注释能够提供代码的解释和说明,使他人更容易理解你的代码。

以下是一些注释规范的建议:1. 在关键代码处添加注释,解释其功能和作用;2. 注释应具有简洁明了的语言,避免使用复杂的技术术语;3. 避免无意义的注释,注释应与代码相辅相成;4. 在函数和文件的开头,提供一份概览性的注释,说明其用途和使用方法。

四、错误处理良好的错误处理能够提高程序的稳定性和可靠性。

以下是一些错误处理的原则:1. 检查输入参数的合法性,防止潜在的错误发生;2. 避免使用魔术数值,使用宏定义或常量来表示特定的含义;3. 使用合适的异常处理机制,如返回错误码或抛出异常。

五、代码Review的重要性代码Review是一种通过检查、审查和评估代码来提高代码质量的过程。

代码Review的重要性体现在以下几个方面:1. 代码Review有助于发现和纠正潜在的代码错误和缺陷;2. 代码Review可以促进编程规范的遵守和统一性的维护;3. 通过代码Review,团队成员之间可以相互学习和交流,提高编程能力。

C语言代码规范

C语言代码规范

C语言代码规范作为一种广泛使用的编程语言,C语言拥有着强大的功能和广泛的应用领域。

为了编写出高质量、可读性强的代码,遵循一定的代码规范是非常重要的。

本文将介绍一些常见的C语言代码规范,旨在帮助程序员写出更加规范、易于维护的代码。

一、命名规范在编写C语言代码时,合理的命名规范可以让代码更加易读、易懂,便于他人理解和维护。

1. 变量名和函数名的命名应使用有意义的英文单词或单词组合,并采用驼峰命名法,即首字母小写,后续单词首字母大写。

例如:userName, calculateScore。

2. 宏定义和枚举常量的命名应全大写,并使用下划线分隔单词。

例如:MAX_SIZE, COLOR_GREEN。

3. 结构体和联合的命名应采用驼峰命名法,首字母大写。

例如:StudentInfo, UserInfo。

二、缩进和空格良好的缩进和适当的空格使用可以提高代码的可读性,减少错误的发生。

1. 使用4个空格进行缩进,避免使用制表符。

2. 函数和循环体内的代码块使用花括号{}包围,且左花括号与代码在同一行,右花括号独占一行。

3. 运算符之间、逗号之后应添加空格,如:a = b + c; for(int i = 0; i < n; i++)。

4. 逻辑语句和赋值语句建议每行只书写一个,以增加可读性。

三、注释规范良好的注释具有很大的意义,可以让他人更容易理解代码的功能和思路。

1. 使用注释对代码进行解释和补充说明,以便他人理解代码的功能。

2. 注释应写在需要解释的代码上方,使用//或/* */进行注释。

3. 函数和重要代码块前应添加注释,说明其功能和预期结果。

四、函数规范函数是程序的基本组织单位,采用规范的函数写法有助于提高程序的可维护性。

1. 函数应具有明确的功能和作用,函数名应符合命名规范,能准确反映函数的功能。

2. 函数的参数如果较多,建议分行书写,并使用逗号对齐。

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语言代码,需要遵守一些编程规范。

1. 命名规范:- 使用有意义的变量和函数名称,避免使用缩写或不明确的名称。

- 变量和函数名称使用小驼峰式命名,以单词首字母小写,后续的单词首字母大写。

- 宏常量使用全部大写字母,并用下划线分隔单词。

2. 注释规范:- 使用注释来解释代码的逻辑、功能或者算法,提高代码的可读性。

- 在函数开头可以用注释来描述函数的输入、输出及功能。

- 注释应该与代码对齐,避免过长或过短,同时避免注释代码。

3. 缩进和空格规范:- 使用合适的缩进,增加代码的可读性。

- 使用4个空格作为一次缩进,而不是使用Tab字符。

- 在运算符和逗号后加一个空格,使代码更易读。

- 在大括号前加一个空格,与控制流语句对齐。

4. 代码结构规范:- 将相关功能的代码块放在一起,便于阅读和维护。

- 逻辑层次清晰,函数和类方法要尽量短小,每个函数的功能单一、复用性强。

- 相关联的变量放在一起声明,并按照类型顺序排序。

- 避免过长的行,推荐每行代码不超过80个字符。

5. 错误处理规范:- 在代码中检查错误并进行适当的处理,避免代码崩溃或者产生不可预料的结果。

- 使用错误码或者异常来处理错误,避免使用魔法数字。

- 使用合适的方式记录错误信息,方便调试和定位问题。

6. 动态内存管理规范:- 在使用动态内存分配时,需要及时释放分配的资源,避免内存泄漏。

- 需要注意避免指针悬挂和使用已经释放的内存。

7. 注重效率和安全性:- 在编写代码时注重代码的性能和效率,避免使用低效的算法。

- 在处理用户输入或者系统API调用时,需要对输入进行有效性检查,避免安全漏洞。

8. 一致性和规范性:- 保持代码的一致性和规范性,遵循编程规范,方便团队协作和代码维护。

- 遵循公司或项目的编码规范,保持团队的代码风格一致。

以上是C语言编程规范的一些基本要点,通过遵守这些规范,可以提高代码的可读性、可维护性和代码质量,使得代码更加规范和高效。

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语言安全编码规范和最佳实践的经验和建议,帮助开发人员编写更健壮、安全的代码。

一、输入验证与数据转换1.1 预防缓冲区溢出C语言常常受到缓冲区溢出攻击的威胁。

开发人员应该采取以下措施来预防此类攻击:- 使用安全字符串函数,如`strncpy`和`strncat`,并且注意正确设置缓冲区的大小。

- 慎用易受攻击的函数,如`gets`和`scanf`,应该使用更安全的替代函数。

- 对于用户输入,尽量避免直接拷贝到固定大小的缓冲区,而是使用动态分配内存的方式。

1.2 验证输入数据的合法性任何外部输入都应该被严格验证,以防止不合法的输入导致系统漏洞。

特别需要注意的是:- 检查输入长度,并确保其符合预期范围。

- 对于需要整数的参数,需要验证其是否在有效范围内。

- 执行数据类型转换时,使用安全的转换函数,并进行错误处理。

二、内存管理和指针操作2.1 分配和释放内存在C语言中,内存管理是一个重要的问题。

以下是一些有助于提高安全性和可靠性的最佳实践:- 分配内存时,使用安全的内存分配函数(如`calloc`和`malloc`),并在使用后及时释放内存(使用`free`函数)。

- 当需要重新分配内存时,使用`realloc`函数,并确保执行错误处理。

- 防止内存泄漏,始终在不需要内存时释放它。

2.2 避免悬空指针和指针越界使用悬空指针或者越界指针可能引发各种未知错误,导致系统崩溃或者被利用。

以下是一些建议的措施:- 初始化指针,并在使用指针前对其进行有效性检查。

- 避免访问已经释放的内存。

- 在指针操作时,确保数组索引不越界。

三、错误处理和异常处理3.1 合理处理错误和异常在编写C代码时,错误和异常处理是非常重要的。

下面是一些关于错误处理和异常处理的最佳实践:- 使用错误码或者异常处理来标识和处理异常情况,而不是简单地忽略或者出现崩溃。

C编程规范

C编程规范

C编程规范C语言编程规范规则:编程时强制必须遵守的约定原则:编程时必须坚持的指导思想建议:编程时必须加以考虑的约定1. 头文件原则1.1 头文件中合适放置接口的声明,不适合放置实现。

头文件是模块或单元的对外接口,头文件中应放置对外部的声明,如对外提供的函数声明,宏定义,类型定义使用前置声明减少#include,尽量是依赖声明而非依赖定义原则1.2 头文件应当职责单一原则1.3 头文件应向稳定的方向包含头文件的包含关系是一种依赖,一般来说应当让不稳定的模块依赖稳定的模块,当不稳定的模块修改变化时不会影响稳定的模块规则1.1 每个.c文件应当有一个同名的.h文件,用于声明对外公开的接口如果不需要对外使用则只在.c中定义使用static约束规则1.2 禁止头文件循环依赖,最佳是单向依赖规则1.3 .c和.h文件禁止包含用不到的头文件规则1.4 头文件应当自包含规则1.5 防止头文件被多次包含,使用#define来保护,为每个头文件配置一个宏,当第一次被包含的时候定义这个宏命名格式PROJECT_PATH_FILENAME_H规则1.6 禁止在头文件里定义变量规则1.7 只能通过包含头文件的方式使用其他.c提供的接口,禁止通过extern的方式使用外部函数接口和变量建议1.1 目录名为模块名,每个模块提供一个.h文件,文件名为目录名,对外提供模块的接口2. 函数原则2.1 一个函数仅完成一个功能原则2.2 重复代码应尽可能提炼成函数规则2.1 避免函数过长,建议在50行左右规则2.2 避免函数代码块嵌套过深,不要超4层规则2.3 可重入函数应避免共享变量,若要使用应通过互斥收到对其保护规则2.4 参数的合法性应由接口函数负责,为了增强安全性,调用者可以先进行校验,规则2.5 对函数的错误返回码要全面处理规则2.6 废弃代码及时清除建议2.1 函数不变参数使用const建议2.2 源文件范围内声明和定义的所有函数,除非外部可见,否则应增加static关键字建议2.3 函数的参数个数不要太多,不超5个3. 标识符命名和定义原则3.1 标识符使用unix风格,单词用小写字母,每个单词用'_'连接原则3.2 命名要清晰,有明确含义,正确使用反义词组命名具有互斥意义的变量和函数规则3.1 文件名统一采用小写字符规则3.2 使用名词或形容词+名词方式命名变量,使用动词或动词+名词命名函数规则3.3 用宏定义常量数字或字符串时,用大小字母命名宏和枚举,宏不要用'_'开头,全局变量加'g'建议3.1 尽量避免名字中出现数字4. 变量原则4.1 一个变量只有一个功能,不要用作多用途原则4.2 结构功能单一,不要面面俱到的数据结构,适度灵活原则4.3 不用或少用全局变量规则4.1 防止局部变量与全局变量同名规则4.2 网络通讯过程中使用结构必须注意字节序。

C语言程序设计规范

C语言程序设计规范

C语言程序设计规范一、注释规范在C语言程序中,注释是非常重要的。

注释可以帮助开发人员理解代码,更好的维护、修改程序。

因此,在编写C语言程序时,注释必须写得清晰明了。

1. 注释格式注释应当采用如下的格式:// 这是单行注释/** 这是多行注释*/2. 注释内容注释的内容应当包括:- 代码的作用- 变量名和函数名的含义- 重要的数据结构3. 注释位置注释应当在代码上方或者在代码旁边进行添加,这可以使得程序更加易读且易于理解。

二、命名规范命名是程序开发中的重要部分。

一个好的命名可以提高代码的可读性和可维护性。

C语言的命名规范应当遵循以下原则:1. 变量名应当使用小写字母,不要使用下划线。

2. 函数名第一个单词应当使用动词,第二个单词应当使用名词。

3. 常量名应当使用大写字母和下划线,如MAX_COUNT。

4. 枚举类型应当使用大写字母,如:typedef enum {RED,GREEN,BLUE} Color;5. 结构体名应当采用驼峰命名法,如:typedef struct {char firstName[20];char lastName[20];} Person;6. 文件名应当使用小写字母和下划线,如my_program.c。

三、缩进规范缩进可以使代码更易于阅读和理解,因此在编写程序时一定要遵循缩进规范。

1. 使用4个空格缩进,而不是使用制表符或两个空格缩进。

2. 如果某一行代码过长,可以在适当的位置断开,如:int result = some_function(param1, param2, param3,param4, param5);3. 对于控制结构(if、while、for等),应当缩进一级,如:if (condition) {// some code}while (condition) {// some code}四、代码风格规范代码的风格对于程序的可读性有着非常重要的影响。

C语言的代码风格规范应当遵循以下原则:1. 大括号应该单独占据一行。

C语言编程规范

C语言编程规范

C语言编程规范一、程序风格1、严格采用阶梯层次组织程序代码:各层次缩进的分格采用VC的缺省风格,即每层次缩进为4格,括号位于下一行。

要求相匹配的大括号在同一列,对继行则要求再缩进4格。

例如:{Code}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语言编程规范

C语言编程规范

C语言编程规范1.基本要求1.1 程序结构清析,简单易懂,单个函数的程序行数尽量不超过200行。

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为4个字节。

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 实现多路分支。

不使用IF,ELSE。

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

3.6 函数只有一个出口。

3.7 不使用条件赋值语句。

3.8 避免不必要的分支。

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

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

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

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语言代码时,遵循一定的代码规范和风格是非常重要的,因为良好的代码规范和风格可以提高代码的可读性、可维护性和可靠性。

本文将介绍一些常用的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编程规范,它们有助于提高代码的可读性、可维护性和可移植性。

1. 格式化代码:- 使用适当的缩进(一般为4个空格)来展示代码的结构。

- 使用空格来分隔运算符和操作数,提高代码的可读性。

- 在代码中使用空行来分隔逻辑上相关的代码块。

2. 命名规范:- 使用具有描述性和有意义的变量名,避免使用单个字母或缩写。

- 使用驼峰命名法(camel case)来命名变量和函数,例如:myVariable,myFunction。

- 使用下划线作为常量名的分隔符,例如:MAX_SIZE。

3. 注释规范:- 使用注释来解释代码的意图、功能、算法和逻辑。

- 在重要的代码段或函数上方添加注释,以帮助其他人理解代码的含义。

- 避免使用不必要的注释,只注释那些对理解代码至关重要的部分。

4. 函数规范:- 函数应该简洁明了,尽量避免超过30行的函数定义。

- 函数应该专注于完成一个具体的任务,并且只处理一个逻辑上的问题。

- 函数应该遵循“单一责任原则”(Single Responsibility Principle),即每个函数只完成一个任务。

5. 错误处理:- 在可能发生错误的地方检查返回值,并采取相应的错误处理措施,例如返回错误码或抛出异常。

- 不要忽略错误,及时的处理错误可以提高程序的稳定性和健壮性。

6. 常量和宏定义:- 使用常量来替代魔法数字,例如使用#define来定义常量,增加代码的可读性。

- 使用宏定义来简化复杂的表达式,但是需要注意宏的副作用和潜在的问题。

7. 文件组织:- 将相关的函数和数据放在一个独立的源文件中,使用头文件来声明函数和数据的接口。

- 在头文件中使用条件编译来避免重复的包含,并提供跨平台的兼容性。

- 使用模块化的设计理念,将代码分成多个文件,提高代码的可维护性和重用性。

8. 资源管理:- 在使用资源(如内存、文件句柄等)后及时释放资源,避免内存泄漏和资源浪费。

C语言编程风格和规范

C语言编程风格和规范

C语言编程风格和规范C语言是一种广泛应用于系统级编程和嵌入式开发的高级编程语言。

为了保证代码的可读性和可维护性,程序员应当遵循一定的编程风格和规范。

本文将介绍一些常见的C语言编程风格和规范。

一、命名规范在C语言中,良好的命名风格可以提升代码可读性。

以下是一些常见的命名规范:1. 变量和函数名使用小写字母,单词之间用下划线(_)分隔,例如:my_variable。

2. 结构体和枚举类型采用首字母大写的驼峰命名法,例如:MyStruct。

3. 宏定义使用全大写字母,单词之间用下划线(_)分隔,例如:MY_MACRO。

二、缩进和空格良好的缩进和空格使用可以使代码结构清晰,提高可读性。

以下是一些常见的缩进和空格规范:1. 使用两个空格或者一个制表符进行代码缩进。

2. 操作符前后加空格,例如:a = b + c。

3. 函数名和左圆括号之间不加空格,例如:printf("Hello World")。

三、注释规范注释对于代码的理解和维护非常重要。

以下是一些关于注释的规范:1. 对于复杂的算法或者重要的函数,应当提供函数头部的注释来解释函数的功能、输入输出参数等。

2. 使用//或者/* ... */来添加注释,简洁明了。

3. 不要在注释中使用绝对的数字或者日期表示,应使用相对的描述,例如:3个元素或者最近更新。

四、函数和模块规范函数和模块的设计可以帮助提高代码的可读性和可维护性。

以下是一些相关的规范:1. 函数应当尽量短小,一个函数只做一件事情。

2. 函数应当有清晰的参数和返回值,避免使用全局变量。

3. 模块应当有清晰的接口定义和模块内部的实现,尽量减少对外部变量和函数的依赖。

五、错误处理规范良好的错误处理可以提高代码的健壮性和可靠性。

以下是一些常见的错误处理规范:1. 函数应当返回适当的错误码或者错误标志,用于外部处理错误情况。

2. 错误处理的代码应当尽量短小,避免嵌套过深的if语句。

3. 错误处理的输出信息应当清晰明了,帮助定位问题。

C语言代码规范命名规范和代码风格

C语言代码规范命名规范和代码风格

C语言代码规范命名规范和代码风格C语言是一门广泛应用于软件开发领域的编程语言,良好的代码规范和命名规范以及代码风格对于代码的可读性和可维护性至关重要。

本文将介绍C语言代码的规范化命名规则和一些常见的代码风格建议,帮助编程人员编写出高质量的C语言代码。

一、命名规范1. 标识符命名方式标识符是C语言中用于表示变量、常量、函数、结构体等的名称,良好的命名方式可以提高代码的可读性。

以下是一些常用的命名规范:- 变量和函数名使用小写字母,可以使用下划线来分隔单词,如"my_variable"。

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

- 宏常量使用全大写字母,单词间用下划线分隔,如"MAX_SIZE"。

- 全局变量使用"g_"作为前缀,如 "g_variable"。

- 局部变量尽量使用有意义的名称,以便于代码理解。

2. 文件名命名方式为了方便代码管理和维护,文件名也应该遵循一定的命名规范:- 文件名使用小写字母,可以使用下划线或连字符来分隔单词,如"my_file.c" 或 "my-file.c"。

- 头文件使用与对应源文件相同的名称,并以".h"为后缀,如"my_file.h"。

二、代码风格1. 缩进和空格良好的缩进和空格使用可以使代码更易读:- 使用4个空格进行缩进,而不是制表符,这样可以保证不同编辑器下的一致性。

- 在二元操作符前后添加空格,但在一元操作符前后不要添加空格,例如 "a = b + c"。

- 在逗号后面添加空格,例如 "int a, b, c;"。

- 在函数调用和定义时,在括号内部不要添加空格,例如"myFunction(a, b)"。

经典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)。

目录一、文件结构1.1 版权和版本的声明1.2 头文件的结构1.3 定义文件的结构二、文件的版式2.1 空行的用法2.2 代码行2.3 代码行内的空格2.4 对齐2.5 长行拆分2.6 修饰符的位置2.7 注释三、命名规则3.1 命名基本规则四、表达式和基本语句4.1 运算符的优先级4.2 复合表达式4.3 if 语句4.4 循环语句的效率五、函数设计5.1 参数的规则5.2 返回值的规则5.3 函数内部实现的规则5.4 其它建议六、其它经验和建议6.1 提高程序的效率一、文件结构每个C程序通常分为两个文件。

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

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

C程序的头文件以“.h”为后缀,C程序的定义文件以“.c”为后缀1.1 版权和版本的声明版权和版本的声明位于头文件和定义文件的开头,主要内容有:(1)版权信息。

(2)文件名称,文件内容摘要。

(3)当前版本号,最后修改日期。

格式如下:/*--------------------------------------------------------------------------文件名称空行文件摘要Version版本号Last Modify: 最后更改日期Copyright (c) 2006 Shenzhen International Solution Software Co., Ltd.All rights reserved.--------------------------------------------------------------------------*/示例如下:/*--------------------------------------------------------------------------Siss8118.hHeader file for Siss5118Version 1.0Last Modify: 2005.12.30Copyright (c) 2006 Shenzhen International Solution Software Co., Ltd.All rights reserved.--------------------------------------------------------------------------*/示例1-1 版权和版本的声明头文件由三部分内容组成:(1)头文件开头处的版权和版本声明(2)预处理块(3)函数和结构体声明等假设头文件名称为Syscfg.h,头文件的结构参见示例1.2.1 为了防止头文件被重复引用,应当用#ifndef/#define/#endif 结构产生预处理块1.2.2 用#include <filename.h> 格式来引用标准库的头文件(编译器将从库目录开始搜索)1.2.3 用#include “filename.h”格式来引用非标准库的头文件(编译器将从工作目录开始搜索) 1.2.4 头文件中只存放函数和变量的“声明”而不存放函数和变量的“定义”1.2.5 结构体定义应使用typedef定义结构体别名,避免直接使用struct直接定义结构体。

1.2.6 尽量避免使用全局变量,确实需要使用全局变量供其它模块引用时,必须在头文件中使用类似extern int value声明。

1.2.7 头文件中存放需要引用的特殊宏(使用#define定义的宏替换)1.2.8 在函数声明前存放函数需要引用的常量宏(使用#define定义的常量)示例如下:// 版权和版本声明见示例1-1,此处省略。

#ifndef _SYSCFG_H // 防止syscfg.h 被重复引用#define _SYSCFG_H#include <absacc.h> // 头文件中需要引用标准库的头文件…#include “main.h” // 头文件中需要引用非标准库的头文件…#define MEM_TYPE code // 特殊宏定义typedef struct //结构体定义{…}tSysCfg;extern int iSysStatus; //全局变量声明#define SYS_RUNNING_STATUS 1 // 全局函数引用宏定义#define SYS_CONFIG_STATUS 2void Function1(…); // 全局函数声明…#endif // _SYSCFG_H示例1-2 头文件的结构定义文件有三部分内容:(1)定义文件开头处的版权和版本声明(参见示例1-1)(2)对一些头文件的引用(3)程序的全局变量,模块静态变量定义(4)程序的模块静态函数声明(5)程序的实现体(包括数据和代码)假设定义文件的名称为Syscfg.c,定义文件的结构参见示例1-3。

// 版权和版本声明见示例1-1,此处省略。

#include <absacc.h> // 模块中需要引用标准库的头文件…#include “main.h” // 模块中需要引用非标准库的头文件…#includ e “Syscfg.h” // 引用本模块头文件#define SYS_STATUS_MAX 1 //模块常量宏定义#define ZeroMemory(Destination,Length) memset((Destination),0,(Length)) //模块特殊宏定义int iSysStatus; //全局变量定义static int iSys; //模块静态变量定义static void ReadCfg(…); // 模块静态函数声明void Function1(…) // 全局函数实现{…}static void ReadCfg(…) // 模块静态函数实现{…}示例1-3 C文件的结构二、文件的版式2.1 空行的用法空行起着分隔程序段落的作用。

空行得体(不过多也不过少)将使程序的布局更加清晰。

空行不会浪费内存,所以不要舍不得用空行。

2.1.1 在每个类声明之后、每个函数定义结束之后都要加空行。

2.1.2 在一个函数体内,函数变量定义后面应加空行分隔。

2.1.3 在一个函数体内,逻揖上密切相关的语句之间不加空行,其它地方应加空行分隔。

示例如下:示例2-1空行的用法2.2 代码行2.1.1 一行代码只做一件事情,如只定义一个变量,或只写一条语句。

这样的代码容易阅读,并且方便于写注释。

2.1.2 if 、for 、while 、do 等语句自占一行,执行语句不得紧跟其后。

示例2-2代码行的风格:左边的为良好的风格,右边为不良的风格// 空行void Function1(…){int i,j; unsigned char cBuff[10]; // 空行 … } // 空行 void Function2(…) { … } // 空行 void Function3(…) { … }// 空行 while (condition) { statement1; // 空行 if (condition) { statement2; } else { statement3; } // 空行 statement4; } x = a + b; y = c + d;z = e + f; if (width < height) { dosomething(); } for (initialization; condition; update) {dosomething(); }// 空行 other(); x = a + b; y = c + d; z = e + f;if (width < height) dosomething(); for (initialization; condition; update) dosomething(); other();2.3 代码行内的空格2.3.1 函数名之后不要留空格,紧跟左括号‘(’。

2.3.2‘(’向后紧跟,‘)’、‘,’、‘;’向前紧跟,紧跟处不留空格。

2.3.3‘,’之后要留空格,如Function(x, y, z)。

如果‘;’不是一行的结束符号,其后要留空格,如for (initialization; condition; update)。

2.3.4 赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符,如“=”、“+=”“>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”,“^”等二元操作符的前后应当加空格。

2.3.5 一元操作符如“!”、“~”、“++”、“--”、“&”(地址运算符)等前后不加空格。

2.3.6 象“[]”、“.”、“->”这类操作符前后不加空格。

2.3.7 对于表达式比较长的for 语句和if 语句,为了紧凑起见可以适当地去掉一些空格,例2.4 对齐2.4.1 程序的分界符‘{’和‘}’应独占一行并位于同一列,同时与引用它们的语句左对齐。

2.5 长行拆分2.5.1 代码行最大长度宜控制在70 至80 个字符以内。

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

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

2.6 修饰符的位置修饰符* 和&应该靠近数据类型还是该靠近变量名,是个有争议的活题。

若将修饰符* 靠近数据类型,例如:int* x; 从语义上讲此写法比较直观,即x 是int 类型的指针。

上述写法的弊端是容易引起误解,例如:int* x, y; 此处y 容易被误解为指针变量。

虽然将x 和y 分行定义可以避免误解,但并不是人人都愿意这样做。

2.6.1 应当将修饰符* 和&紧靠变量名例如:char *name;int *x, y; // 此处y 不会被误解为指针2.7 注释C 语言的注释符为“/*…*/”。

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

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

虽然注释有助于理解代码,但注意不可过多地使用注释。

参见示例2-6。

2.7.1 注释是对代码的“提示”,而不是文档。

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

注释的花样要少。

2.7.2 如果代码本来就是清楚的,则不必加注释。

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

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

相关文档
最新文档