本文介绍了基于 Doxygen 的 C++ 注释风格，包括文件头、类定义、成员变量、成员函数、函数实现、命名空间等的注释规则。推荐使用 C++ 风格的行注释，如 `///`，并利用 `brief` 和 `detailed` 区分简短和详细描述。还提到了 Doxygen 的 `@brief`, `@param`, `@return`, `@see`, `@note`, `@warning` 等命令用于增强文档结构。"
125781951,13871089,Python跨平台安装指南：Windows、Linux与MacOS,"['Python编程', '系统环境配置', '软件安装', '跨平台开发']
Title: 基于 Doxygen 的 C++ 注释风格
Date: 2015-01-13 18:00
Category: Linux
Tags: C++, comment style
Slug: doxygen_cpp_comment_style
Author: Qian Gu
Summary: 总结基于 Doxygen 的 C++ 注释规则
本文内容参考自网上博客内容
重新整理排版了一下。写本文的主要目的是备忘，当作快速参考来查。
Doxygen
若想用 Doxygen 生成漂亮的文档，我们必须在以下几个地方添加 Doxygen 风格的注释：
文件头(包括 头文件 .h 和 源文件 .cpp)
主要用于版权声明，描述本文件的功能，以及作者、版本信息等。
类的定义
主要用于描述类的功能，同时也可以包含使用方法、注意事项的 brief description。
类的成员变量定义
对该成员变量进行 brief description。
类的成员函数定义
对该成员函数的功能进行 brief description。
函数实现
对函数的功能、参数、返回值、需要注意的问题、相关说明等进行 detailed description。
C++ Comment Style
Doxygen 支持多种注释风格，比如 JavaDoc-like 风格，Qt 风格等。在写 C++ 代码时，我们应该遵守 C++ 的行注释风格，所谓行注释风格，是指一般 C++ 程序员避免使用 C 风格的注释符号 /* */，而是使用 3 个连续的 / 作为注释的开头。除了这个区别之外，其他部分和 JavaDoc 风格类似：
一个对象的 brief description 用单行的 /// 开始，并且写在代码前面。一般 brief 写在头文件中，对象的声明之前。
一个
最低0.47元/天 解锁文章
扫一扫
962
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
