0-0 doxygen注释简规(基础)

博客迁移已迁移到https://www.guyuemeng.com

概述

本文档主要抽取了doxygen中的一种注释方式，用于C++编码的自动文档生成，避免代码中多种风格代码注释的混用。同时考虑到会有JAVA方面的需求，所以本文的内容将会更加偏向于JavaDoc。主要用于规范自己开发的注释风格，当前从最简单的整理，后续涉及到再补充。

注释风格

/** 
 * ...Details of comment...
 */

概要

概要信息为注释中的第一段语句，第一个**.出现的位置为brief结束，注意.**后方添加一个空格。接着的为详细描述信息以及其他信息。
注：JAVADOC_AUTOBRIEF选项设为YES

/**
 * Start a brief. 
 * Start descriptions.
 */

代码后注释

针对文件、结构体、联合、类、枚举等的成员注释不在之前，而是成员之后，需要使用代码后注释。

enum {
    NUM_ZERO, ///< 这是0
    NUM_ONE   ///< 这是1
}