C 编码规范

命名规范

变量名：

1）全局变量：以g_开头； 2）静态变量：以s_开头； 3）类的成员变量：以m_开头，如：m_Utility； 4）指针变量：以p开头，比如：pParser； 5）函数参数：
以v开头，如：vPassName； 若函数参数是输出参数，则以vo开头 若函数参数是指针，可以只以v开头，而不用vp
C++编程规范
C++编程规范


一、文件结构 二、命名规范 三、注释 四、缩进 五、代码优化
文件结构

为了让代码的框架更清 晰，且观看代码更方便， 特别是在文件特别多的 时候，往往在工程中都 采用如右边的文件结构：
命名规范

1、命名准则 2、变量名 3、函数名 4、类名

命名规范

函数名：

函数名，第一个字母小写，后面每个单词的首 个字母大写，如：onActivate()； 类名以大写C开头，如：CRain。

类名：

注释

单行注释：


用//statement 或者 /*statement*/在此行上面 添加注释，例如： //get the view matrix currentViewMatrix.makeLookAt(m_pApp>getEye(), m_pApp->getLookat(), m_pApp>getUp());

函数原型的格式

缩进

函数体中的缩进

局部变量声明，赋值，循环等在函数体中的缩 进，注意的是，不同的函数体之间要存在空格。 定义多个相同类型的变量并且赋值的时候，要 注意所有的变量的上下对齐缩进，如框架中的 common.h中的很多变量的声明。

对齐缩进

代码优化

源自文库
函数的参数尽量采用引用传递或者指针传递，慎 用值传递：

在最终完成代码后，如果有注释了的代码，且 这些代码是可能有用处的，那就必须要注明此 注释代码的作用。方便后面的人了解代码。
缩进

全局变量的格式

全局变量放在程序的最前面，主要的格式是将 相同类型的变量的声明放在一起，保持有序。 函数原型放在全局变量下面，根据返回值类型 进行有序的排放，并且，相同的返回值类型中， 建议根据函数名的字母排序。
注释

临时代码注释

在向程序中添加调试代码，或者往程序中写入 临时代码的时候，要添加注释，注明代码的用 途。如，添加调试代码的时候，要在调试代码 的两端加上：
/**************DEBUG CODE**********/ …… /***********************************/

尽量避免使用全局变量，静态变量
谢谢！
注释

函数开始处必须加如下注释，说明函数的 功能以及需要注意的地方：
/******************************************************/ //FUNCTION: adjust the number of particles according to the rain intensity //NOTE: …… void CRain::setIntensity(float vIntensity) {……}
CRenderingPass* createRenderingPassObject(const std::string& vPassName);


一个函数包含的代码尽量控制在100行； 一个类包含的代码尽量控制在500行； 非常不好的习惯：拷贝，粘贴代码！

不利于修改代码，所以拷贝的地方都需进行修改 原则：代码拷贝两次以上，需将被拷贝的代码独立写 为一个函数
命名规范

命名规则：

变量、函数、类…的名字都必须要有意义
在代码特别多的时候，名字的意义一目了然 使用英文进行命名，不要用拼音


void CRain::setLightPosition(osg::Vec3& vLightPosition) 像a,b,x,y,t等这些变量一般在循环体里使用，或 作为临时的局部变量时使用