编码规范

编码规范

2、对于.h头文件

         一、无论是系统自动生成的文件还是自己手动生成的头文件，文件开头添加注释该问文件的主要的功能，添加自定义函数要说明该函数的主要功能，成员变量也是要说明该变量的作用以及默认值和在何种地方的会进行调用。

 

/**     
 * 用一行来描述类
 *
 *#include "XX.h" <BR>
 *-llib
 *
 * 类的详细说明
 * 
 * @seesomething
 */

 

#ifndef $FILE_BASE_UPPER$_H
#define $FILE_BASE_UPPER$_H
 
// 在这里包含系统头文件
//
 
// 在这里包含项目头文件
//
 
// 在这里包含局部头文件
//
 
// 在这里放置前置引用
//
 

 

class $ClassName$
{
public:
    // 类的生命周期控制函数，如构造和析构，以及状态机
 
    /**
    *Default constructor.
    */
    $ClassName$(void);
 
    /**
    *Copy constructor.
    *
    *@param from The value tocopy to this object.
    */
    $ClassName$(const $ClassName$& from);
 
    /**
    *Destructor.
    */
    virtual ~$ClassName$(void);
 
    // 在这里放置类的运算操作符
 
    /**
    *Assignment operator.
    *
    *@param from THe value toassign to this object.
    *
    *@return A reference to thisobject.
    */
    XX&                     operator=($ClassName$&from); 
 
    // 在这里放置类的操作                      
    // 在这里放置属性存取
    // 在这里放置类的状态查询
 
protected:
private:
};
 
// 内联方法定义
//
 
// 外部引用
//
 
#endif  //$FILE_BASE_UPPER$_H

 

 

Doxygen - Class Comment

/*!
 * \class $classname$
 *
 * \brief $end$
 *
 * \author %USERNAME%
 * \date $MONTHLONGNAME$ $YEAR$
 */

 

 

Doxygen - Class Comment (Long)

/*!
 * \class $classname$
 *
 * \ingroup GroupName
 *
 * \brief $end$
 *
 * TODO: long description
 *
 * \note 
 *
 * \author %USERNAME%
 *
 * \version 1.0
 *
 * \date $MONTHLONGNAME$ $YEAR$
 *
 * Contact: user@company.com
 *
 */

 

Doxygen - Header Comment

/*!
 * \file $FILE_BASE$.$FILE_EXT$
 *
 * \author %USERNAME%
 * \date $MONTHLONGNAME$ $YEAR$
 *
 * $end$
 */

 

Doxygen - Header Comment (Long)

/*!
 * \file $FILE_BASE$.$FILE_EXT$
 * \date $DATE$ $HOUR$:$MINUTE$
 *
 * \author %USERNAME%
 * Contact: user@company.com
 *
 * \brief $end$
 *
 * TODO: long description
 *
 * \note
*/

 

3、.cpp文件

         一、说明文件有头文件声明，具体有哪些方法，大概的功能是什么。

         二、对应每个函数的功能逻辑，参数 返回值；

//************************************

// Method:   ~CCpuIndexView

// FullName: CCpuIndexView::~CCpuIndexView

// Access:   virtual protected

// Returns:  

// Qualifier:

//************************************

         三、函数功能的内部的主要分支和主要逻辑注释。

   //