1. dox常用命令

讲述基本的常用标签命令

1.1. dox文献信息

@author ...	作者
@brief ...	摘要
@file ...	文件声明

1.2. dox状态信息

@version ...	版本推荐使用$Id$
@todo ...	改进,可以指定针对的版本

1.3. dox模块信息

@var ...	模块变量说明
@typedef ...	模块变量类型说明

1.4. dox函式信息

@param p ...	参数 p 说明
@arg ...	列表说明参数信息
@return ...	返回值说明
@retval ...	返回值类型说明

1.5. dox提醒信息

@note ...	注解
@attention ...	注意
@bug ...	问题
@warning ...	警告

1.6. dox关联信息

@sa ...

参考资料

2. dox标签格式

约定文档化标签的语法

epydoc 支持两种标签的语法！
doxygen:
```
 \tag 内容...
```
Javadoc:
```
 @tag 内容...
```
为了简化学习，在新浪标准化开发中我们推荐统一使用
```
 @tag: 内容...
```
格式

3. dox注释风格

约定文档化标签放置

依照C/C++ JAVA 类别语言注释风格自然的进行

/** 
 *  一个示范类，描述在此
 */
class Test{
  public:
    /** 
     * 一个 enum.
     * 详细描述可以多行
     */
    enum TEnum { 
          TVal1, /**单行注释*/            
         } 
       *enumPtr, /**< enum pointer. Details. */
      /**
       * 构造器函式
       * 详细描述可以多行
       */
      Test();
      /**
       * 一个普通函式 描述和参数等等的叙述
       * @param a 整数参数
       * @param s 字串指针参数
       * @see Test() 参看..
       * @return 返回值描述
       */
       int testMe(int a,const char *s);
      /**
       * 纯虚成员函式
       * @see testMe() 参看
       * @param c1 第一参数
       * @param c2 第二参数
       */
       virtual void testMeToo(char c1,char c2) = 0;
      /** 
       * 一个公共变量
       * 详细描述
       */
       int publicVar;
};

DoxyGen 支持多种注释声明,仅仅是在标准基础上添加一点儿:

JavaDoc 样式的:
- ```
 /**
 * ... text ...
 */
```
Qt 样式的:
- ```
 /*!
 ... text ...
 */
```

C++ 样式的:

/// 
 /// ... text ...
 ///
 or
 //!
 //! ... text ...
 //!

我们推荐简化的 Qt 风格

  /*! 
  引发的多行注释 
  ...
  */
  正常結束

-- ZoomQuiet (2005-01-26)