个人编程规范(不断更新)

一、写在前面

总结给自己看的规范,如果能给大家借鉴当然更好~~

二、变量命名

(1)成员变量以 m_ 开头,之后采用大驼峰法命名,如:

class Test {
public:
    ... ...
    int m_Name;
}

(2)局部变量采用小驼峰法命名,如:

int solve() {
    int localModuleName;
    ... ...
}

(3)函数参数采用短横线连接,如:

WinSwitcherType getModuleWinSwType(int m_id,int m_modeValue);

三、函数命名

函数命名皆采用小驼峰法,如:

std::vector <logic_BasicPara*> getAllModePara(); //返回当前模式所有参数

四、注释

1 源文件头部注释

Ø 列出:作者、编写日期和描述。
Ø 示例:

/* 
* Copyright:bupt
* funtion: 端口选择器实体
* Date:2015-09-01
* Author: Bill Wang
*/

2 函数头部注释

Ø 列出:功能、输入参数、输出参数、返回值、调用关系(函数、表)等。
Ø 示例:下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议
要包含在内。

///
/// \brief 
/// \para 
/// \return 
///

你可能感兴趣的:(编程,C++,c,函数,规范)