一个比较好的代码注释方法

.h文件中，每个函数前一行都做说明

public:
 //用pGeo构造一棵八叉树
 void BuildOCTree(CGeometry * pGeo);

 

.cpp文件中，如下，函数前说明内容分别是功能，返回值，传递参数

/*---------------------------------------------------------------------------
功能：构建几何体的自适应八叉树
返回值：无
传递参数：pGeo需要构建八叉树的几何体对象指针
-----------------------------------------------------------------------------*/
void COctree::BuildOCTree(CGeometry * pGeo)

{

.............

}

 

这样感觉很爽。