C++编码规范(7)

2021-01-20 15:19

break;

}

2.2.6 其它应该考虑进行注释的地方

规范级别:建议 规则描述:

除上面说到的,对于以下情况,也应该考虑进行注释:

变量的声明、定义。通过注释,解释变量的意义、存取关系等; 例如:

int m_nNumber; //记录图形个数。被SetDate( )、GetDate( )使用。 数据结构的声明。通过注释,解释数据结构的意义、用途等; 例如:

//定义结构体,存储元件的端点。用于将新旧的端点对应。 typedef struct {

int nBNN; int nENN; int nBNO; int nENO; }Element;

分支。通过注释,解释不同分支的意义; 例如:

if(m_iShortRadio == 0) //三相的情况 {

strvC.Format("%-10.6f", vC); straC.Format("%-10.6f", aC); }

else if(m_iShortRadio == 1) //两相的情况 {

strvC = _T(""); straC = _T(""); }

调用函数。通过注释,解释调用该函数所要完成的功能; 例如:

SetDate(m_nNumber ); //设置当前的图形个数。

赋值。通过注释,说明赋值的意义; 例如:

m_bDraw = true; //将当前设置为绘图状态 l程序块的结束处。通过注释,标识程序块的结束。 例如:

if (name = = White) {

if (age = = 20)


C++编码规范(7).doc 将本文的Word文档下载到电脑 下载失败或者文档不完整,请联系客服人员解决!

下一篇:中职生物学实验教学与学生创新能力的培养

相关阅读
本类排行
× 注册会员免费下载(下载后可以自由复制和排版)

马上注册会员

注:下载文档有可能“只有目录或者内容不全”等情况,请下载之前注意辨别,如果您已付费且无法下载或内容有问题,请联系我们协助你处理。
微信: QQ: