常用英文注释一览

文件头注释

/*! @file
********************************************************************************
<PRE>
Module              :
File                :
Related Files       :
Intro               :
Author              : <xxx>
Version             : 1.0
--------------------------------------------------------------------------------
MutiThread Safety   :
On Exception Safety :
--------------------------------------------------------------------------------
Notes               :
--------------------------------------------------------------------------------
Change History      :
Date         Version  Changed By      Changes
YYYY/MM/DD   1.0      <xxx>           Create
</PRE>
********************************************************************************

* Copyright(c) YYYY, by <xxx>, All rights reserved

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

　

标准类注释

以下定义的各种成员类型可以根据实际需要增删。

/*! @class
********************************************************************************
<PRE>
Class    :
Desc     :
Exception:
--------------------------------------------------------------------------------
Notes    :
Examples :
--------------------------------------------------------------------------------
Author   : <xxx>
</PRE>
*******************************************************************************/
class CXXX
{
public:
//////////////////////////////////////////////////////////////////////// defines

public:
////////////////////////////////////////////////////////////////////// big three

public:
////////////////////////////////////////////////////////////////// virtual funcs

public:
/////////////////////////////////////////////////////////////////// public funcs

public:
/////////////////////////////////////////////////////////////////// static funcs

protected:
///////////////////////////////////////////////////////////////// internal funcs

private:
//////////////////////////////////////////////////////////////// private defines

private:
////////////////////////////////////////////////////////////////// private funcs

private:
///////////////////////////////////////////////////////////////////// properties

private:
////////////////////////////////////////////////////////////// static properties

private:
//////////////////////////////////////////////////////////////// disabled method

};

　

标准函数注解

/*! @function
********************************************************************************
<PRE>
Function  :
Desc      :
Params    :
Return    :
Exception :
--------------------------------------------------------------------------------
Complexity:
Notes     :
Examples  :
--------------------------------------------------------------------------------
Author    : <xxx>
</PRE>
*******************************************************************************/

　

语句/函数组

// [[ Group Title

    ...

// ]] [Group Title]

OR

// ---- [[ Group Title

    ...

// ---- ]] [Group Title]

　

语句块

// =========================================================================
// = Action Title

// @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
// @@ Special Action Title

// @@ Special Action Title
// @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

　

分割带

// #############################################################################
// #############################################################################


// #############################################################################
// ######################################################## Local data and funcs
    ...
// ######################################################## Local data and funcs
// #############################################################################


// #############################################################################
// ################################################################## class CXXX
    ...
// ################################################################## class CXXX
// #############################################################################


// #############################################################################
// ################################################################# Other Title
    ...
// ################################################################# Other Title
// #############################################################################