C/C++编码规范
2016-02-26 16:12
363 查看
一、头文件;
1、所有头文件都应该使用#define防止头文件被多重包含。为保证命名唯一性,头文件命名应基于所在项目源代码树的全路径。格式是:<PROJECT>_<PATH>_<FILE>_H_
2、使用前置声明尽量减少.h文件中#include的数量;
3、只有当函数只有10行一下时才会将其定义为内联函数;
4、定义函数时,参数的顺序为:输入参数在前,输出参数在后;
5、将包含次序标准话可增强可读性、避免隐藏依赖,次序如下:C库,其他库的.h、项目内的.h;
二、命名约定;
1、函数命名、变量命名、文件命名应具有描述性,不要随意缩写;
2、文件名要全部小写,可以包含下划线和短线;
2、宏和枚举使用全部大写+下划线;
3、变量、文件、存取函数使用全部小写+下划线,类成员变量以下划线结尾,全局变量以g_开头;
4、普通函数、类型、常量等使用首字母大写,没有下划线,常亮命名前面加k;
三、注释;
1、注释风格统一,变量可以选择不注释;
2、函数声明处注释描述函数功能,定义处描述函数实现;
3、出彩或者复杂的代码块前要加注释;比较隐晦的地方要在行尾空两格加入注释;
四、格式:
1、每一行代码的字符数不超过80。
2、尽量不要使用非ASCLL字符,使用时必须使用UTF-8格式。
3、只使用空格进行缩进,每次缩进2个空格;
4、垂直留白越少越好。水平留白因地制宜;
5、保持声明的统一性;
注:
1、使用指针时应尽量将其局部化,并且安全第一;
2、const能用则用,提倡const在前;
1、所有头文件都应该使用#define防止头文件被多重包含。为保证命名唯一性,头文件命名应基于所在项目源代码树的全路径。格式是:<PROJECT>_<PATH>_<FILE>_H_
2、使用前置声明尽量减少.h文件中#include的数量;
3、只有当函数只有10行一下时才会将其定义为内联函数;
4、定义函数时,参数的顺序为:输入参数在前,输出参数在后;
5、将包含次序标准话可增强可读性、避免隐藏依赖,次序如下:C库,其他库的.h、项目内的.h;
二、命名约定;
1、函数命名、变量命名、文件命名应具有描述性,不要随意缩写;
2、文件名要全部小写,可以包含下划线和短线;
2、宏和枚举使用全部大写+下划线;
3、变量、文件、存取函数使用全部小写+下划线,类成员变量以下划线结尾,全局变量以g_开头;
4、普通函数、类型、常量等使用首字母大写,没有下划线,常亮命名前面加k;
三、注释;
1、注释风格统一,变量可以选择不注释;
2、函数声明处注释描述函数功能,定义处描述函数实现;
3、出彩或者复杂的代码块前要加注释;比较隐晦的地方要在行尾空两格加入注释;
四、格式:
1、每一行代码的字符数不超过80。
2、尽量不要使用非ASCLL字符,使用时必须使用UTF-8格式。
3、只使用空格进行缩进,每次缩进2个空格;
4、垂直留白越少越好。水平留白因地制宜;
5、保持声明的统一性;
注:
1、使用指针时应尽量将其局部化,并且安全第一;
2、const能用则用,提倡const在前;
相关文章推荐
- C语言(内存管理)
- [土狗之路]coursera C语言进阶习题 二维数组右上左下遍历
- C++标准库简介、与STL的关系。
- 1060. Are They Equal (25)
- c++ 中 operator的两种用法
- c++ 内存泄漏检查
- [memory]C语言关于字节对齐的问题
- 机试练习 北理14年01、02题 打开文件顺序
- C++学习之内联函数、引用变量、函数重载、函数模板
- 数组初始化
- 【C++11新特性】 C++11智能指针之shared_ptr
- C语言头文件避免重复包含、#pragma once和#ifndef的区别
- c++中用boost实现共享内存创建map容器
- c++ 文件写样例
- 著名的C++三大库boost、loki、stlport,及其他c++库应用简述
- C语言内存管理分析
- 0:编写虚幻引擎中的UC和C++代码
- MFC的使用技巧(如何彻底删除一个类)
- [置顶] c语言入门之项目4.5——利用“迭代”另类求和
- [土狗之路]coursera C语言进阶习题 计算矩阵边缘元素之和