文档章节

C++标准注释原则 - 基于doxygen的C++注释

尘中远
 尘中远
发布于 2016/05/12 23:50
字数 2366
阅读 2
收藏 0


标注总述

下载国外的源代码,往往能看到附带的说明文档,文档都有详细的说明,大部分文档都可以通过doxygen这个跨平台软件生成,doxygen并不能随便读取你的C++的注释,必须按照一定的规则才能生成,所以在编写代码时,一定要按照标准写注释,否则会为以后带来许多麻烦

下面介绍C++的标注写法,c++不推荐c语言式的/* */风格注释,这里,除了文件头使用这种注释外其余到使用C++风格的注释。

先看看总述:


文件头:

/*!
* \file Ctext.h
* \brief 概述 
* 
*详细概述 
* 
* \author 作者名字
* \version 版本号(maj.min,主版本.分版本格式) 
* \date 日期 
*/

命名空间:
/// \brief 命名空间的简单概述 
/// 
///命名空间的详细概述
namespace text
{
 ……
}


类说明:
/// \brief Ctext的doxygen测试
///
/// 作doxygen测试用
class Ctext
{
}


函数标注
   方法1:
/// \brief 函数简要说明-测试函数
    /// \param n1 参数1
    /// \param c2 参数2
    /// \return 返回说明
    bool text(int n1,Ctext c2);
   方法2:
/// \brief 函数简要说明-测试函数
    /// 
    /// 函数详细说明,这里写函数的详细说明信息,说明可以换行
    /// ,如这里所示,同时需要注意的是详细说明和简要说明之间必须空一行
    /// ,详细说明之前不需要任何标识符
    /// \param n1 参数1说明
    /// \param c2 参数2说明
    /// \return 返回说明
    /// \see text
    bool text2(int n1,Ctext c2);


变量及枚举
 
int m_a;     ///< 成员变量1m_a说明
    double m_b; ///< 成员变量2m_b说明


    /// \brief 成员变量m_c简要说明
    ///
    /// 成员变量m_c的详细说明,这里可以对变量进行
    ///详细的说明和描述,具体方法和函数的标注是一样的
    float m_c;


    /// \brief xxx枚举变量的简要说明
    ///
    /// xxx枚举变量的详细说明--枚举变量的详细说明和函数的详细说明
    ///的写法是一致的。每个枚举变量下可以进行单独说明
    enum{
        em_1,///< 枚举值1的说明
        em_2,///< 枚举值2的说明
        em_3 ///< 枚举值3的说明
    };


1.文件头说明

文件头说明按照如下格式写
/*!
* \file Ctext.h
* \brief 概述 
* 
*详细概述 
* 
* \author 作者,包含email等 
* \version 版本号(maj.min,主版本.分版本格式) 
* \date 日期 
*/

上注释等下于下面这种写法
/*!
 \file Ctext.h
\brief 概述 
详细概述 
\author 作者,包含email等 
\version 版本号(maj.min,主版本.分版本格式) 
\date 日期 
*/


对于vs编译器可能中间那行*号比较麻烦,可以不写,对于Qt这种要去掉中间的*号反而是件麻烦事就不用去掉
用doxygen生成注释如下效果




2. 命名空间

命名空间说明如下写

/// \brief 命名空间的简单概述 
/// 
///命名空间的详细概述
namespace text
{

}

doxygen的说明写法都是类似于
/// \brief
/// 
///

以下将会见到很多这样的写法
上注释的doxygen效果如下


3. 类说明


类的注释和函数一样,

/// \brief Ctext的doxygen测试
///
/// 作doxygen测试用
class Ctext
{
}

上注释用doxygen生成文档效果如下:




4.函数注释原则

函数详细注释位于头文件,cpp文件只对函数做简明注释
cpp文件不做///的注释,否则会和头文件重叠

4.1 函数简要说明

注释方法1:
/// \brief 函数简要说明-测试函数
    /// \param n1 参数1
    /// \param c2 参数2
    /// \return 返回说明
    bool text(int n1,Ctext c2);

简要注释此注释会让doxygen生成函数简要说明和参数说明
生成结果如:


4.2 函数简要说明+详细说明


/// \brief 函数简要说明-测试函数
    /// 
    /// 函数详细说明,这里写函数的详细说明信息,说明可以换行
    /// ,如这里所示,同时需要注意的是详细说明和简要说明之间必须空一行
    /// ,详细说明之前不需要任何标识符
    /// \param n1 参数1说明
    /// \param c2 参数2说明
    /// \return 返回说明
    bool text2(int n1,Ctext c2);

上注释用doxygen生成文档效果如下:



4.3 不带简要说明的函数标注

/// 函数说明-测试函数
    /// 
    /// 函数详细说明,这里写函数的详细说明信息,说明可以换行
    /// ,如这里所示,同时需要注意的是详细说明和简要说明之间必须空一行
    /// ,详细说明之前不需要任何标识符
    /// \param n1 参数1说明
    /// \param c2 参数2说明
    /// \return 返回说明
    bool text3(int n1,Ctext c2);

上注释用doxygen生成文档效果如下:

这里没有说明



4.4 带参见的写法

/// \brief 函数说明-测试函数4
    /// \param n1 参数1说明
    /// \param c2 参数2说明
    /// \return 返回说明
    /// \see text3 text2 text
    bool text4(int n1,Ctext c2);

上注释用doxygen生成文档效果如下:



\see 上可以带中文等说明,doxygen会自动识别代码里存在的函数

5.变量注释


变量注释用///< 对变量进行说明,对于详细信息可以加\brief
  
int m_a;     ///< 成员变量1m_a说明
    double m_b; ///< 成员变量2m_b说明

    /// \brief 成员变量m_c简要说明
    ///
    /// 成员变量m_c的详细说明,这里可以对变量进行
    ///详细的说明和描述,具体方法和函数的标注是一样的
    float m_c;

如果变量需要详细说明的可已按照m_c的写法写,注意,m_b和m_c之间一定需要空行,否则会导致m_b的简述消失
上注释用doxygen生成文档的具体效果如下





6.枚举


枚举变量的标注方法如下

/// \brief xxx枚举变量的简要说明
    ///
    /// xxx枚举变量的详细说明--枚举变量的详细说明和函数的详细说明
    ///的写法是一致的。每个枚举变量下可以进行单独说明
    enum{
        em_1,///< 枚举值1的说明
        em_2,///< 枚举值2的说明
        em_3 ///< 枚举值3的说明
    };


枚举的总体说明和函数的写法一致,每个枚举变量的说明和变量的说明写法一致
上注释用doxygen生成效果如下:







7.doxygen的设置和中文问题


7.1 生成私有成员


如果想生成私有成员(doxygen默认不生成私有成员),可以如下设置
选择Expert标签的Build项,勾选EXTRACT_PRIVATE即可

7.2 中文问题

中文有时候是乱码
对于vs2010的文档,默认是gb2312,可以设置
Expert标签的Project项目的DOXYFILE_ENCODING 为 GB18030
INPUT_ENCODING 为 GB18030

另外Project项目的生成语言(OUTPUT_LANGUAGE)选择Chinese


对于其他的代码文件如果中文乱码,可以用文本编辑器转换代码文本编码为UTF-8带BOM的(注意这有可能影响代码,所以转换编码时要备份),再进行导出。





8.vs2008、vs2010 及以上IDE的快速标注方法

vs2010 等编译器并不能像Qt Creator那样生成上述标注样式,但是可以集成到vs的工具栏里,集成方法如下图所示:


这样在标注时可以直接从工具箱拖曳了,非常方便



附:

Ctext.h

/*!
* \file Ctext.h
* \brief 概述 
* 
*详细概述 
* 
* \author 作者,包含email等 
* \version 版本号(maj.min,主版本.分版本格式) 
* \date 日期 
*/

#pragma once
/// \brief 命名空间的简单概述 
/// 
///命名空间的详细概述
namespace text
{

}

/// \brief Ctext的doxygen测试
///
/// 作doxygen测试用
class Ctext
{
public:
    Ctext(void);
    ~Ctext(void);
    /// \brief 函数简要说明-测试函数
    /// \param n1 参数1说明
    /// \param c2 参数2说明
    ///    \return 返回说明
    bool text(int n1,Ctext c2);
    /// \brief 函数简要说明-测试函数
    /// 
    /// 函数详细说明,这里写函数的详细说明信息,说明可以换行
    /// ,如这里所示,同时需要注意的是详细说明和简要说明之间必须空一行
    /// ,详细说明之前不需要任何标识符
    /// \param n1 参数1说明
    /// \param c2 参数2说明
    ///    \return 返回说明
    bool text2(int n1,Ctext c2);
    /// 函数说明-测试函数
    /// 
    /// 函数详细说明,这里写函数的详细说明信息,说明可以换行
    /// ,如这里所示,同时需要注意的是详细说明和简要说明之间必须空一行
    /// ,详细说明之前不需要任何标识符
    /// \param n1 参数1说明
    /// \param c2 参数2说明
    ///    \return 返回说明
    bool text3(int n1,Ctext c2);
    /// \brief 函数说明-测试函数4
    /// \param n1 参数1说明
    /// \param c2 参数2说明
    ///    \return 返回说明
    /// \see text3 text2 text
    bool text4(int n1,Ctext c2);

    int m_a;     ///< 成员变量1m_a说明
    double m_b; ///< 成员变量2m_b说明

    /// \brief 成员变量m_c简要说明
    ///
    /// 成员变量m_c的详细说明,这里可以对变量进行
    ///详细的说明和描述,具体方法和函数的标注是一样的
    float m_c;

    /// \brief xxx枚举变量的简要说明
    ///
    /// xxx枚举变量的详细说明--枚举变量的详细说明和函数的详细说明
    ///的写法是一致的。每个枚举变量下可以进行单独说明
    enum{
        em_1,///< 枚举值1的说明
        em_2,///< 枚举值2的说明
        em_3 ///< 枚举值3的说明
    };
};

另外可看看这篇文章里面的注释:http://blog.csdn.net/czyt1988/article/details/21743595



 

© 著作权归作者所有

共有 人打赏支持
尘中远
粉丝 1
博文 26
码字总数 47436
作品 0
朝阳
程序员
C++ 跨平台多功能扩展库 - cpgf

cpgf 可为C++代码增加反射(元数据)、序列化、以及Luau和Python脚本绑定等功能,且不依赖任何外部工具。 cpgf 的目标是扩展C++语言,其中包含许多易于使用的功能,这些功能仅在其他更高级别...

wqking
09/17
0
0
编程注释大家都会写吧,这种“挨踢”的注释玩过没?

注释大家都会写,主要用来帮助程序员理解代码的意思,下面列举了几个真实的注释,如果是当您接手这样的项目看到这样的注释时,会做如何反应呢?笔者这里表示已经哭笑不得了… 1.看下面的这段...

这个人很懒什么都没留下
07/23
0
0
C/C++之C及C++发展史及标准

Tips:  1. 本人当初学习C/C++的记录。  2. 资源很多都是来自网上的,如有版权请及时告知!  3. 可能会有些错误。如果看到,希望能指出,以此共勉! C和C++   C++是C语言的一个超集。C...

zcshoucsdn
2017/03/06
0
0
强大不代表完美——C++几个不方便的地方。

引言:本文自工作以来使用过C++、Java、Python、Groovy、Objective C、Lisp,我最初学的就C++的,当时对她情有独钟,灵活和强大充分体现了她的智慧,随着你对她理解的深入,你会发现随便一段...

爱捣鼓
2014/02/20
0
0
Java程序员如何高效而优雅地入门C++

Java程序员如何高效而优雅地入门Cpp,由于工作需要,需要用C++写一些模块。关于C++ 的知识结构,虽说我有过快速学习很多新语言的经验,但对于C++ 我也算是老手,但也还需要心生敬畏,本文会从...

小欣妹妹
04/23
0
0

没有更多内容

加载失败,请刷新页面

加载更多

OSChina 周六乱弹 —— 放假前期焦虑症晚期

Osc乱弹歌单(2018)请戳(这里) 【今日歌曲】 @andonny :分享Matteo的单曲《Panama》: 《Panama》- Matteo 手机党少年们想听歌,请使劲儿戳(这里) @新垣吉衣OSC :我发现只要去有小朋友...

小小编辑
10分钟前
11
4
wait()被notify()后,接着执行wait()后面的语句

wait()被notify()后,接着执行wait()后面的语句

noteman
42分钟前
1
0
Ubuntu集群-使用MAAS开始裸机安装

Ubuntu使用MAAS装机的七个步骤。 1、Setup your hardware You need one small server for MAAS and at least one server which can be managed with a BMC. It is recommended to have the M......

openthings
55分钟前
3
0
OSX | SafariBookmarksSyncAgent意外退出解决方法

1. 启动系统, 按住⌘-R不松手2. 在实用工具(Utilities)下打开终端,输入csrutil disable, 然后回车; 你就看到提示系统完整性保护(SIP: System Integrity Protection)已禁用3. 输入reboot回车...

云迹
今天
4
0
面向对象类之间的关系

面向对象类之间的关系:is-a、has-a、use-a is-a关系也叫继承或泛化,比如大雁和鸟类之间的关系就是继承。 has-a关系称为关联关系,例如企鹅在气候寒冷的地方生活,“企鹅”和“气候”就是关...

gackey
今天
4
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部