什么//! [0]是指Qt C ++示例代码?

时间:2016-10-06 13:19:21

标签: c++ qt

我刚刚打开了一个Qt服务器示例源代码。以下是其中一个文件:http://code.qt.io/cgit/qt/qtbase.git/tree/examples/network/fortuneserver/server.cpp

它有//! [0]之类的评论。这是一个例子:

//! [3]
    connect(tcpServer, &QTcpServer::newConnection, this, &Server::sendFortune);
//! [3]

我以前从没见过他们。他们是什么意思?

2 个答案:

答案 0 :(得分:11)

它在Qt中用于从源代码生成Web文档。通常,无论您在哪里找到//! [NUMBER],您都可以在网络文档中看到该段代码。 此外,它位于代码的末尾,因此文档生成器工具可以知道代码的哪个部分在哪里。

当然,//!标签可以在源代码中找到,但不能在生成的文档中找到。否则,文档将变得不可读。

他们为什么用这个? 它以//开头(意思是它是注释,因此编译器将忽略它),并且它们为生成器工具添加了“!”,因此它可以将代码注释与文档分开资讯

//![1] This line will be generated into the documentation explaining the following function
void somethingDifficult()
{
   //This would be a normal comment, so not exported to documentation
}
//![1] Here we mark the end of the export to the documentation

答案 1 :(得分:3)

我无法看到//!该链接中的任何地方,但//是声明该行的其余部分是注释。