QDoc标记命令——编写C++文档的好帮手
QDoc是Qt提供的用于生成API文档的工具,它可以根据源代码自动生成文档,并且支持一些特殊格式的标记命令。下面我们就来介绍一下QDoc标记命令都有哪些,以及它们的使用方法。
- \brief
该命令用于在类、函数等成员声明前添加简短的概述信息,例如:
/*!
* \brief MyClass类的简要说明
*/
class MyClass {
public:
/*!
* \brief myFunction函数的简要说明
*/
void myFunction()