c语言程序代码编写规范.pdf

语言 程序代码编写规范 C 语言 程序代码编写规范 C （初级程序员 讨论版） （初级程序员 讨论版） 前言 前言 一个好的程序编写规范是编写高质量程序的保证。清晰、规范的源程序不仅仅是方便阅 一个好的程序编写规范是编写高质量程序的保证。清晰、规范的源程序不仅仅是方便阅 读，更重要的是能够便于检查错误，提高调试效率，从而最终保证软件的质量和可维护性。 读，更重要的是能够便于检查错误，提高调试效率，从而最终保证软件的质量和可维护性。 说明 说明 此文挡还在完善改进中，如有不足，欢迎指正。 此文挡还在完善改进中，如有不足，欢迎指正。 本文档主要适用于刚刚开始接触编程的初学者。 本文档主要适用于刚刚开始接触编程的初学者。 对于具有一定工程项目开发经验的程序员，建议学习C 语言程序代码编写规范 对于具有一定工程项目开发经验的程序员，建议学习C 语言程序代码编写规范 —高级版。 —高级版。 目录 目录 1 代码书写规范 1 代码书写规范 2 注释书写规范 2 注释书写规范 3 命名规范 3 命名规范 内容 内容 1 代码书写规范 1 代码书写规范 函数定义 函数定义 每个函数的定义和说明应该从第 1 列开始书写。函数名 （包括参数表）和函数体的花括 每个函数的定义和说明应该从第 1 列开始书写。函数名 （包括参数表）和函数体的花括 号（“{”和 “}”）应该各占一行。在函数体结尾的括号 （“}”）后面应该加上注释，注释中 号（“{”和 “}”）应该各占一行。在函数体结尾的括号 （“}”）后面应该加上注释，注释中 应该包括函数名，这样比较方便进行括号配对检查，也可以清晰地看出来函数是否结束。 应该包括函数名，这样比较方便进行括号配对检查，也可以清晰地看出来函数是否结束。 范例 1：函数的声明 范例 1：函数的声明 void matMyFunct ion (int n) void matMyFunct ion (int n) { { …… …… } /* matMyFunct ion*/ } /* matMyFunct ion*/ 空格的使用 空格的使用 使用空格分割所有演算符号和操作数。 使用空格分割所有演算符号和操作数。 这条规则的例外是 “-”, ““.”, “()”和 “[]”，这些操作符和操作数之间不空格。 这条规则的例外是 “-”, ““.”, “()”和 “[]”，这些操作符和操作数之间不空格。 当需要把一个程序行的内容分成几行写时，操作符号应该放在行末，而不是下一行的开 当需要把一个程序行的内容分成几行写时，操作符号应该放在行末，而不是下一行的开 头。 头。 缩进的设置 缩进的设置 代码书写应该遵从结构化的要求，采用缩进的格式。最小缩进量为 4 个空格，整个文件 代码书写应该遵从结构化的要求，采用缩进的格式。最小缩进量为 4 个空格，整个文件 内部应该统一，不要混用 Tab 键和 4 个空格这两种情况，因为不同的编辑器对 Tab 键的处理 内部应该统一，不要混用 Tab 键和 4 个空格这两种情况，因为不同的编辑器对 Tab 键的处理