ns-3的c++代码规范

一、 统一风格的重要性


特别注意: 以下风格并不是C++的强制标准,而是为了便宜于他人阅读,
便于不同开发者之间的交流以及其他开发人员的进一步开发、维护而设立的共同规范。

二、 命名


(1) 函数名、方法名、类名的命名方法为:


a. 单词首字母大写,其他字母都小写;

b. 即使是缩写,如EDCA,也改成 Edca
举例:

my computer => 命名为: MyComputer
MAC, PHY => 命名为: Mac, Phy //不要把所有字母都大写,即使这是一个缩写。
IP => 命名为 Ip

如: class MyClass
{
...

};

bool IsTrue ()
{ 
...

}


c. 函数定义、调用的时候,函数名和()之间留一个空格。 如: IsTrue ()


(2)变量名的命名


a. 首字母小写
变量 user name => 命名为: userName
//这样做的好处是: 用户看到userName就这知道这是一个变量名,看到UserName就知道这是一个类名


b. 全局变量以 g_ 开头
static int g_aStaticVar = 100;
int g_aGlobalVar = 1000;


c. 类的成员变量以 m_ 开头

class MyClass
{
   
  void MyMethod (int aVar);         //方法名MyMethod
  int m_aVar;               //类成员变量 m_aVar
  static int m_anotherVar;
};


d. 自定义类型以 _t 结尾
如:

typedef unsigned int uint8_t;
typedef int NewTypeOfInt_t;


e. 变量的定义及赋初值:
e1. 每个变量单独一行定义,不推荐 int width,height 这种定义方法,推荐用两行定义:

  int width;
  int height;

e2. 变量定义推荐赋初值(在main函数中直接赋初值,在类中用构造函数赋初值);
e3. 对于意义明显如width的变量定义可以不用注释,意义不明显的变量,一定要进行注释;
e4. 变量赋值的时候,推荐等号两边都有一个空格(不是强制,仅仅只是为了便于阅读)


如:

  
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值