C语言代码规范
- 格式：pdf
- 大小：370.65 KB
- 文档页数：35
下载文档原格式
合集下载
C语言代码规范
C语言代码规范C语言是一种广泛应用于编程领域的高级编程语言，具有跨平台、效率高、灵活性强等优点。
编写规范合乎标准的C语言代码有助于提高代码的可读性、可维护性和可移植性。
本文将介绍一些常用的C语言代码规范，以帮助开发者编写高质量的C语言程序。
一、代码格式1. 缩进：使用四个空格进行缩进，不要使用制表符。
这样可以保证在不同编辑器或显示器上显示的代码缩进一致。
2. 行长度限制：每行代码应尽量保持在80个字符以内，超过限制的代码可以进行适当换行。
换行时要注意保持代码的清晰可读性，一般可以采用缩进来表达代码的层次关系。
3. 大括号：大括号的位置应该和相关语句对齐，且起始的大括号应该放在语句所在行的末尾，而不是单独另起一行。
4. 空格和空行：在适当的情况下使用空格和空行可以提高代码的可读性。
例如，在运算符和操作数之间使用空格，不同的代码块之间使用空行进行分割等。
二、命名规范1. 变量名：使用有意义的变量名，尽量避免使用单个字符或简单的缩写表示变量。
变量名应该忠实地反映其所代表的含义。
2. 函数名：函数名应使用动词和名词的组合，具体描述函数的功能。
函数名应该清晰地表达其所完成的操作或所返回的结果。
3. 常量名：常量名使用全大写字母，并使用下划线进行分隔。
例如，MAX_LENGTH。
4. 类型名：类型名使用首字母大写的驼峰命名法，例如，StudentInfo。
5. 宏定义名：宏定义名使用全大写字母，并使用下划线进行分隔。
例如，PI。
三、注释规范1. 单行注释：使用"//"进行单行注释，注释符号后面应该留一个空格。
注释应该清晰明了，解释代码的用途或特殊处理等。
2. 多行注释：使用"/*"和"*/"进行多行注释。
多行注释通常用于解释一整块代码的功能或原理等。
3. 函数注释：在每个函数定义的上方加上函数注释，注释中应该包含函数的功能描述、输入参数的说明、返回值的含义以及可能抛出的异常等信息。
C语言代码编程规范
2.1 排版
• 2.1.1空格的使用：
在两个以上的关键字、变量、常量进行对等操作时，它 们之间的操作符之前、之后或者前后要加空格；进行非对等 操作时，如果是关系密切的立即操作符（如－>），后不应 加空格. – 逗号、分号只在后面加空格 – 比较操作符, 赋值操作符，算术操作符，逻辑操作符，位 域操作符等双目操作符的前后加空格 – "!"、"~"、"++"、"--"、"&"（地址运算符）等单目操作符前 后不加空格 – “->”、“.”前后不加空格 – if、for、while、switch等与后面的括号间应加空格，使if 等关键字更为突出、明显。
说明：以免用不同的编辑器阅读程序时，因TAB键所设 置的空格数目不同而造成程序布局不整齐。
• 2.1.13 程序块的分界符（如大括号‘{‟和‘}‟）应各独 占一行并且位于同一列，同时与引用它们的语句左对 齐。 在函数体的开始、类的定义、结构的定义、枚举的定 义以及if、for、do、while、switch、case语句中的程 序都要采用如上的缩进方式。
word = (high << 8) | low if ((a | b) && (a & c)) if ((a | b)< (c & d))
(1) (2) (3)
由于： high << 8 | low = ( high << 8) | low a | b && a & c = (a | b) && (a & c) 所以（1）（2）虽然表意不清，但不会出错 由于：a | b < c & d = a | （b < c） & d ，所以（3）造成判断条件出错
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语言是一种通用的编程语言，广泛应用于嵌入式系统、操作系统、驱动程序以及各种应用程序的开发中。
为了提高代码的可读性、可维护性和可移植性，制定一套严格的代码规范是非常必要的。
1. 缩进与空格：- 使用4个空格进行缩进，不要使用Tab键。
- 在运算符两侧以及逗号后加上一个空格。
2. 命名规范：- 变量、函数和类型的命名采用小驼峰命名法，例如myVariable。
- 全局变量以g_开头，静态变量以s_开头。
- 宏定义全部大写，并用下划线分隔单词。
3. 函数定义：- 函数名应该能够描述函数的功能。
- 函数名应该以动词开头，使用小驼峰命名法。
- 函数的参数列表应该明确指明参数的类型和名称。
4. 注释：- 在每个函数之前添加简要的注释，说明函数的功能、参数和返回值。
- 在复杂的代码块中添加必要的注释，解释代码的逻辑和目的。
5. 头文件：- 头文件应该包含必要的宏定义、类型定义和函数声明，不要包含具体的函数实现。
- 头文件应该有相应的宏定义来防止多次包含。
6. 文件结构：- 文件应该按照功能模块进行组织，每个功能模块放在一个独立的文件中。
- 文件中的代码应该按照逻辑顺序进行排列，函数之间使用空行进行分隔。
7. 魔法数值：- 不要直接在代码中出现魔法数值，应该使用常量或者宏来表示。
- 大多数情况下，常量应该在文件的头部定义，并加上相应的注释。
8. 错误处理：- 对于可能出现错误的函数调用，应该检查返回值并进行相应的错误处理。
- 错误处理可以是返回特定的错误码或者抛出异常，但应该保持一致。
9. 括号和空行：- 括号应该与控制语句在同一行，并在括号内留出空格。
- 在函数和控制语句之间应该使用适当的空行进行分隔，提高可读性。
10. 可移植性：- 不要使用与平台相关的特性或者语法。
- 使用标准的数据类型和函数接口，避免使用非标准扩展。
- 避免使用与编译器相关的优化选项。
以上是一些常用的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语言是一门广泛使用的编程语言，为了保证程序的可读性、可维护性和可移植性，编程人员需要遵守一定的编程规范。
本文将介绍一些常见的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 编程规范可以提高代码的可读性、可维护性，减少错误和 bug 的发生。
以下是一些常见的 C 编程规范建议：1. 代码缩进：缩进应该使用相同数量的空格符或制表符，一般为 4 个空格或一个制表符。
缩进可以使代码结构更清晰，便于阅读。
2. 命名规范：变量、函数和常量的命名应该具有描述性，能够准确反映其用途和含义。
使用驼峰命名法或下划线命名法是常见的命名风格。
注意避免使用与 C 语言关键字相同的名称。
3. 注释规范：代码中应该包含必要的注释，用于解释代码的逻辑、实现细节和算法。
注释应该清晰明了，不要出现拼写错误或过多的冗余信息。
4. 函数长度：函数的长度应该适中，不要过长。
一般来说，一个函数应该只负责一个具体的功能，如果函数过长应该考虑分割成多个子函数。
5. 模块化设计：程序应该使用模块化的设计原则，将功能相似或相关的代码块组织成不同的模块或文件。
这样可以提高代码的可维护性和可重用性。
6. 错误处理：程序应该正确处理各种可能发生的错误和异常情况。
避免简单地使用错误代码或忽略错误，而是采取适当的错误处理措施，例如返回错误码或抛出异常。
7. 变量声明：变量应该在使用前先声明，并且尽量在被使用的代码块的起始处进行声明。
声明时应给予适当的初始值，以避免使用未初始化的变量。
8. 代码复用：避免重复的代码和冗余的逻辑。
可以通过编写可重用的函数、使用循环和条件语句等方式来提高代码的复用性和可读性。
9. 括号的使用：括号的使用是保证代码逻辑准确性的重要方式之一。
建议在 if、for、while、switch 等语句块的使用中，使用括号来明确代码块的范围，以避免出现逻辑错误。
10. 代码格式：代码应该有一致的格式，用以增加可读性。
应避免使用过长的代码行，一般建议每行代码长度不超过 80 个字符。
综上所述，C 编程规范是编写高质量、可维护代码的基本准则。
c语言规范
c语言规范C语言规范是指在C语言程序设计中所应遵守的一些规则和约定。
遵循C语言规范可以使程序有更好的可读性、可维护性和可移植性。
以下是C语言规范的一些主要内容：1. 缩进：使用适当的缩进来显示代码的层次结构，通常使用四个空格进行缩进。
2. 注释：对代码进行详细的注释，使其它人可以很容易地理解代码的含义和功能。
3. 变量命名：变量名应具有描述性，简洁明了，并遵循一定的命名规则。
通常使用驼峰命名法或下划线命名法。
4. 常量命名：常量名通常使用全大写字母，并使用下划线分隔单词，以便于区分变量和常量。
5. 函数命名：函数名应具有描述性，并遵循一定的命名规则。
通常使用驼峰命名法。
6. 空格：在运算符和关键字之间应有适当的空格，以增加代码的可读性。
例如，a = b + c; 而不是a=b+c;。
7. 行长限制：一行代码的长度应控制在80个字符以内，以保证代码的可读性和可维护性。
8. 括号：在使用括号时，应保持代码的可读性。
例如，当if语句的条件较长时，可以将条件拆分成多行，并使用适当的缩进。
9. 运算符优先级：在使用多个运算符时，应尽量使用括号来明确运算的优先级，以保证代码的正确性。
10. 文件组织：将相关的函数和变量放在一个文件中，并使用适当的头文件进行声明和引用。
11. 头文件保护：在头文件中使用预处理指令进行保护，避免重复引用和定义。
12. 函数参数：当函数有多个参数时，应将参数的类型和名称清晰明了地列出，并使用适当的缩进。
13. 错误处理：在程序中进行错误处理，避免出现未处理的异常情况。
14. 变量声明：在变量声明时，应尽量将变量的定义放在使用之前，并给变量一个初始值。
15. 可移植性：在编写代码时，应尽量避免使用与特定平台相关的功能和语法，以保证代码的可移植性。
总之，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语言是一种广泛使用的编程语言，为了使代码可读性强，易于维护，编写出高质量的C语言代码，需要遵守一些编程规范。
1. 命名规范：- 使用有意义的变量和函数名称，避免使用缩写或不明确的名称。
- 变量和函数名称使用小驼峰式命名，以单词首字母小写，后续的单词首字母大写。
- 宏常量使用全部大写字母，并用下划线分隔单词。
2. 注释规范：- 使用注释来解释代码的逻辑、功能或者算法，提高代码的可读性。
- 在函数开头可以用注释来描述函数的输入、输出及功能。
- 注释应该与代码对齐，避免过长或过短，同时避免注释代码。
3. 缩进和空格规范：- 使用合适的缩进，增加代码的可读性。
- 使用4个空格作为一次缩进，而不是使用Tab字符。
- 在运算符和逗号后加一个空格，使代码更易读。
- 在大括号前加一个空格，与控制流语句对齐。
4. 代码结构规范：- 将相关功能的代码块放在一起，便于阅读和维护。
- 逻辑层次清晰，函数和类方法要尽量短小，每个函数的功能单一、复用性强。
- 相关联的变量放在一起声明，并按照类型顺序排序。
- 避免过长的行，推荐每行代码不超过80个字符。
5. 错误处理规范：- 在代码中检查错误并进行适当的处理，避免代码崩溃或者产生不可预料的结果。
- 使用错误码或者异常来处理错误，避免使用魔法数字。
- 使用合适的方式记录错误信息，方便调试和定位问题。
6. 动态内存管理规范：- 在使用动态内存分配时，需要及时释放分配的资源，避免内存泄漏。
- 需要注意避免指针悬挂和使用已经释放的内存。
7. 注重效率和安全性：- 在编写代码时注重代码的性能和效率，避免使用低效的算法。
- 在处理用户输入或者系统API调用时，需要对输入进行有效性检查，避免安全漏洞。
8. 一致性和规范性：- 保持代码的一致性和规范性，遵循编程规范，方便团队协作和代码维护。
- 遵循公司或项目的编码规范，保持团队的代码风格一致。
以上是C语言编程规范的一些基本要点，通过遵守这些规范，可以提高代码的可读性、可维护性和代码质量，使得代码更加规范和高效。
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
#endif //_LIBPAG_H_
1.2 文件内容分段
一个文件中包含多类内容，每类内容作为一段放在一起，每段之前用长串“/////”标明。
例如：一个文件中包含两类接口，捕包接口和过滤接口分别组成一段。
6
/////////////// 捕包接口 ///////////////
///取一个报文 int pag_get();
+ STAT_SIZE_PER_FRAM * sizeof(struct perm);
act_task_table[frame_id * STAT_TASK_CHECK_NUMBER + index].occupied = stat_poi[index].occupied;
◆循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操 作符处划分新行，操作符放在新行之首。
int cnt; ///<cnt 是一个计数用的变量
///判断参数是否全法 if (0 == a || 0 == b || 0 == c) {
return 0; /// 非法则返回 0 }
///数学加，对各个参数进行求和. ///@warning 这样做的算法不是太好 a = a + b + c;
///返回参数和 return a; }
构定义，全局变量，函数。
//////////////////////////////////////// ///@file doxygen_test.h ///文件头是第 1 部分，每个文件必须有，注释采用 doxygen 格式 /// ///@brief 用于详细说明此程序文件完成的主要功能 ///@see 参考内容与其他模块或函数的接口等关系 /// ///修改记录:修改历史记录列表，每条修改记录应包括修改日期、修改者及修改内容。 ///按时间倒序书写，最新的修改在最前面 /// ///@author yuanqb@ ///@date 2012-07-23 /// ///使用 doxygen 注释格式 /// ///@author yuanqb@ ///@date 2012-06-01 /// ///增加实例 ////////////////////////////////////////
{
12
... // program code
}
◆若函数或过程中的参数较长，则要进行适当的划分。 示例： n7stat_str_compare((BYTE *)(&stat_object), (BYTE *)(&(act_task_table[taskno].stat_object)), sizeof(_STAT_OBJECT));
改为： int test_length(int len) {
int var1; char *var2;
if (arg < 0) {
printf("[Error]file.func: argument err! arg = %d\n", arg); }
var1 = 5;
//局部变量初始化
◆代码中关系较为紧密的代码应尽可能相邻，便于理解。 示例：以下代码布局不太合理。
示例： if ((taskno < max_act_task_number)
&& (n7stat_stat_item_valid (stat_item))) {
... // program code }
for (i = 0, j = 0; (i < word[word_index].word_length) && (j < word_length); i++, j++)
曙光信息产业（北京）有限公司 SBB 项目组
C 语言代码规范
文件状态： 文档编号：
[√] 草稿
作 者：
[ ] 正式发布 密 级：
■普通
□秘密
[ ] 正在修改
□机密
□绝密
完成日期：
文档保存状态：
(由配置管理人员填写)
修订历史
版本 0.1.0
修订内容 参考 netfirm 组代码规范创建
完成日期 2012.06.15
(3)"!"、"~"、"++"、"--"、"&"（地址运算符）等单目操作符前后不加空格。
*p = 'a';
// 内容操作"*"与内容之间
flag = !is_empty; // 非操作"!"与内容之间
9
p = &mem; i++;
// 地址操作"&" 与内容之间 // "++","--"与内容之间
return 1; }
应如下书写： if (p == NULL) {
return 0; } else {
return 1； }
11
◆较长的语句（一般>80 字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作 符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。
示例： perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN
(4)"->"、"."前后不加空格。
p->id = pid;
// "->"指针前后不加空格
(5) if、for、while、switch 等与后面的括号间应加空格，使 if 等关键字更为突出、明显。 if (a >= b && c > d)
(6)函数名后面不加空格 void get_pkt(int sid);
(7)指针定义符号*的前面加空格。 char *get_string() {
char *str; }
◆不要用 tab 代替空格（一般编辑器中都可以配置不用 tab），以免用不同的编辑器阅读程序时，因 TAB 键所设置的空格数目不同而造成程序布局不整齐。
1.6 换行
◆避免一行有两条语句。
10
示例：如下例子不符合规范。 rect.length = 0; rect.width = 0;
// 如果是头文件，需要避免多次包含 #ifndef _LIBPAG_H_ #define _LIBPAG_H_
4
// 包含文件列表是第 2 部分，可能需要 // 先写标准路径 #include <linux/types.h> //__u64
//再写当前路径 #include "my_header.h"
◆每层缩进 4 个空格，注意不要用 tab 代替 4 个空格。
1.4 空行
◆必须空行的地方包括： A.文件头与文件正文之间;
7
B.每两个函数的实现之间; C.一个函数内部结构相对独立的代码段之间。 D.函数结束之前的 return 之前。
示例：如下例子不符合规范。 int repssn_ind, repssn_ni; if (!valid_ni(ni)) {
5
///@brief 这是函数摘要，测试 doxygen 的测试函数 ///@param a 参数 a 的说明 ///@param b 参数 b 的说明 ///@param c 参数 C 的说明 ///@return 返回值 失败返回 0， 成功返回其他 /// ///@todo 要改进的内容的说明 ///@see 要参考的其他内容的说明 ///@warning 需要注意的内容的说明 int test_function(int a, int b, int c) {
2
审批历史
版本
审批意见
审批日期
审批人
注：本表中只需填写正式发布版本的审批记录，一般由项目经理或者 QA 进行审批。
3
1 排版 1.1 文件
◆头文件要和实现文件分离，头文件要用#ifdefine #define #endif 避免多次包含。
◆文件开头要给出文件的功能、修改历史记录等信息。
◆文件内容的排版顺序为：文件头，包含文件（先写标准路径，再写当前路径），宏定义，数据结
示例：以下代码布局不太工整。 int func(int arg) {
int var1 = 5; //避免声明时赋值 if (arg < 0)
13
{ printf("[Error]file.func: argument err! arg = %d\n", arg);
}
char *var2; //避免中间声明 //some code
n7stat_flash_act_duration(stat_item, frame_id * STAT_TASK_CHECK_NUMBER + index, stat_object);
1.7 函数实现
◆函数内部的代码结构顺序是： A.局部变量声明（如果有局部变量）； B.参数合法性检查（如果函数是ＡＰＩ接口）； C.变量初始化（需要赋初始值的局部变量，都在这一段初始化，不要在声明的同时赋值）。 D.实现代码。
//宏定义列表是第 3 部分 ///@name ioctl 命令 //@{ #define NF_IOC (SIOCDEVPRIVATE + 3) #define NF_IOC_GET_BAR0 0 #define NF_IOC_GET_DRIVER_MEM 1 //@}
///@name 硬件参数 //@{ #define NF_MAX_RX_STREAM_NUM 16 #define NF_NIC_MEM_SIZE (16 << 20) //@}
1.2 文件内容分段
一个文件中包含多类内容，每类内容作为一段放在一起，每段之前用长串“/////”标明。
例如：一个文件中包含两类接口，捕包接口和过滤接口分别组成一段。
6
/////////////// 捕包接口 ///////////////
///取一个报文 int pag_get();
+ STAT_SIZE_PER_FRAM * sizeof(struct perm);
act_task_table[frame_id * STAT_TASK_CHECK_NUMBER + index].occupied = stat_poi[index].occupied;
◆循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操 作符处划分新行，操作符放在新行之首。
int cnt; ///<cnt 是一个计数用的变量
///判断参数是否全法 if (0 == a || 0 == b || 0 == c) {
return 0; /// 非法则返回 0 }
///数学加，对各个参数进行求和. ///@warning 这样做的算法不是太好 a = a + b + c;
///返回参数和 return a; }
构定义，全局变量，函数。
//////////////////////////////////////// ///@file doxygen_test.h ///文件头是第 1 部分，每个文件必须有，注释采用 doxygen 格式 /// ///@brief 用于详细说明此程序文件完成的主要功能 ///@see 参考内容与其他模块或函数的接口等关系 /// ///修改记录:修改历史记录列表，每条修改记录应包括修改日期、修改者及修改内容。 ///按时间倒序书写，最新的修改在最前面 /// ///@author yuanqb@ ///@date 2012-07-23 /// ///使用 doxygen 注释格式 /// ///@author yuanqb@ ///@date 2012-06-01 /// ///增加实例 ////////////////////////////////////////
{
12
... // program code
}
◆若函数或过程中的参数较长，则要进行适当的划分。 示例： n7stat_str_compare((BYTE *)(&stat_object), (BYTE *)(&(act_task_table[taskno].stat_object)), sizeof(_STAT_OBJECT));
改为： int test_length(int len) {
int var1; char *var2;
if (arg < 0) {
printf("[Error]file.func: argument err! arg = %d\n", arg); }
var1 = 5;
//局部变量初始化
◆代码中关系较为紧密的代码应尽可能相邻，便于理解。 示例：以下代码布局不太合理。
示例： if ((taskno < max_act_task_number)
&& (n7stat_stat_item_valid (stat_item))) {
... // program code }
for (i = 0, j = 0; (i < word[word_index].word_length) && (j < word_length); i++, j++)
曙光信息产业（北京）有限公司 SBB 项目组
C 语言代码规范
文件状态： 文档编号：
[√] 草稿
作 者：
[ ] 正式发布 密 级：
■普通
□秘密
[ ] 正在修改
□机密
□绝密
完成日期：
文档保存状态：
(由配置管理人员填写)
修订历史
版本 0.1.0
修订内容 参考 netfirm 组代码规范创建
完成日期 2012.06.15
(3)"!"、"~"、"++"、"--"、"&"（地址运算符）等单目操作符前后不加空格。
*p = 'a';
// 内容操作"*"与内容之间
flag = !is_empty; // 非操作"!"与内容之间
9
p = &mem; i++;
// 地址操作"&" 与内容之间 // "++","--"与内容之间
return 1; }
应如下书写： if (p == NULL) {
return 0; } else {
return 1； }
11
◆较长的语句（一般>80 字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作 符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。
示例： perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN
(4)"->"、"."前后不加空格。
p->id = pid;
// "->"指针前后不加空格
(5) if、for、while、switch 等与后面的括号间应加空格，使 if 等关键字更为突出、明显。 if (a >= b && c > d)
(6)函数名后面不加空格 void get_pkt(int sid);
(7)指针定义符号*的前面加空格。 char *get_string() {
char *str; }
◆不要用 tab 代替空格（一般编辑器中都可以配置不用 tab），以免用不同的编辑器阅读程序时，因 TAB 键所设置的空格数目不同而造成程序布局不整齐。
1.6 换行
◆避免一行有两条语句。
10
示例：如下例子不符合规范。 rect.length = 0; rect.width = 0;
// 如果是头文件，需要避免多次包含 #ifndef _LIBPAG_H_ #define _LIBPAG_H_
4
// 包含文件列表是第 2 部分，可能需要 // 先写标准路径 #include <linux/types.h> //__u64
//再写当前路径 #include "my_header.h"
◆每层缩进 4 个空格，注意不要用 tab 代替 4 个空格。
1.4 空行
◆必须空行的地方包括： A.文件头与文件正文之间;
7
B.每两个函数的实现之间; C.一个函数内部结构相对独立的代码段之间。 D.函数结束之前的 return 之前。
示例：如下例子不符合规范。 int repssn_ind, repssn_ni; if (!valid_ni(ni)) {
5
///@brief 这是函数摘要，测试 doxygen 的测试函数 ///@param a 参数 a 的说明 ///@param b 参数 b 的说明 ///@param c 参数 C 的说明 ///@return 返回值 失败返回 0， 成功返回其他 /// ///@todo 要改进的内容的说明 ///@see 要参考的其他内容的说明 ///@warning 需要注意的内容的说明 int test_function(int a, int b, int c) {
2
审批历史
版本
审批意见
审批日期
审批人
注：本表中只需填写正式发布版本的审批记录，一般由项目经理或者 QA 进行审批。
3
1 排版 1.1 文件
◆头文件要和实现文件分离，头文件要用#ifdefine #define #endif 避免多次包含。
◆文件开头要给出文件的功能、修改历史记录等信息。
◆文件内容的排版顺序为：文件头，包含文件（先写标准路径，再写当前路径），宏定义，数据结
示例：以下代码布局不太工整。 int func(int arg) {
int var1 = 5; //避免声明时赋值 if (arg < 0)
13
{ printf("[Error]file.func: argument err! arg = %d\n", arg);
}
char *var2; //避免中间声明 //some code
n7stat_flash_act_duration(stat_item, frame_id * STAT_TASK_CHECK_NUMBER + index, stat_object);
1.7 函数实现
◆函数内部的代码结构顺序是： A.局部变量声明（如果有局部变量）； B.参数合法性检查（如果函数是ＡＰＩ接口）； C.变量初始化（需要赋初始值的局部变量，都在这一段初始化，不要在声明的同时赋值）。 D.实现代码。
//宏定义列表是第 3 部分 ///@name ioctl 命令 //@{ #define NF_IOC (SIOCDEVPRIVATE + 3) #define NF_IOC_GET_BAR0 0 #define NF_IOC_GET_DRIVER_MEM 1 //@}
///@name 硬件参数 //@{ #define NF_MAX_RX_STREAM_NUM 16 #define NF_NIC_MEM_SIZE (16 << 20) //@}