注释规范

注释目的：为了以后更好维护代码，也方便读写代码，更高效率的解决问题


总规则


1、如果对应内容为空，则可不写


2、一行注释的内容最好能在开发工具的可视范围内，可以以28个汉字为标准，显示如下


//////////////////////////////////////////////////////////////////////////
// Descript : 注释注释注释注释注释注释注释注释注释注释注释注释注释注释
//////////////////////////////////////////////////////////////////////////


3、如果一行不够用，可以换下一行，再继续注释，换行后格式为：// + tab + tab + : + 空格，如
// Descript : 注释注释注释注释注释注释注释注释注释注释注释注释注释注释
// : 注释注释注释注释注释注释注释注释注释注释注释注释注释注释
// : 注释注释注释注释注释注释注释注释注释注释注释注释注释注释






-------------------------------------------------------------------
文件：


1、格式
//////////////////////////////////////////////////////////////////////////
// Project : 
// FileName : 
// Descript : 
// Version : 
// Create Date : 
// Modify Date : 
// Author : 
// Modifier : 
//////////////////////////////////////////////////////////////////////////


2、说明
Project-工程名
FileName-文件名
Descript-描述
Version-版本号
Create Date-创建日期
Modify Date-修改日期
Author-创建这个文件的作者
Modifier-更改者


-------------------------------------------------------------------
结构体、枚举:


1、格式
//////////////////////////////////////////////////////////////////////////
// Descript : 
//////////////////////////////////////////////////////////////////////////


2、说明
Descript-描述


-------------------------------------------------------------------
类:


1、格式
//////////////////////////////////////////////////////////////////////////
// Class : 
// Descript : 
//
//////////////////////////////////////////////////////////////////////////


2、说明
Class-类名
Descript-描述 


-------------------------------------------------------------------
函数：


1、格式
// Descript : 
// Parameter : 
// : 
// : 
// Return : 


2、说明
Descript-描述
Parameter-参数说明及描述，如：
// Parameter : uid 玩家uid
// : CPartyMember 队伍
return-返回值说明


-------------------------------------------------------------------
成员变量、成员函数、变量、语句


1、格式
在后面加Tab+//+空格+描述


2、例子
如: 
m_TestBtn; // 测试按钮
if(!p) // 如果p不为空


-------------------------------------------------------------------
语句功能模块


1、格式
直接在这个模块上方写注释:// 注释


2、例子


模块1
// 显示队员字体
if(it->Uid == g_ClientData.m_wLeader)
g_lpDXWnd->m_Font14.DrawText(_S("%s", it->MemberName),ShowX+77, ShowY+12, D3DCOLOR_XRGB(0XFF, 0X00, 0X00));
else
g_lpDXWnd->m_Font14.DrawText(_S("%s", it->MemberName),ShowX+77, ShowY+12, D3DCOLOR_XRGB(0XFF, 0XFF, 0XFF));


模块2
// 天赋
if(it->Class)
{
int GiftAlloc[3] = {it->GiftAlloc1, it->GiftAlloc2, it->GiftAlloc3};
int index=0; std::string strTemp;
strTemp.clear();
for(int i=0; i<3; i++)
{
index=(it->Class-1)*3+i;
strTemp += _S("%s%d ", gszGiftTypeTextEx[index], GiftAlloc[i]);
}
g_pGlobalFont->DrawText(strTemp.c_str(), ShowX+77, ShowY+48, D3DCOLOR_XRGB(0X00, 0XAE, 0XFF));
}