c++ -//! [0] 在 Qt 源代码中

Question

的含义是什么//! [n] (n = 0, 1, 2 ...) Qt 示例项目的 C++/QML 源代码中的标记？

例如:

//! [0]
GLWidget::GLWidget(Helper *helper, QWidget *parent)
    : QGLWidget(QGLFormat(QGL::SampleBuffers), parent), helper(helper)
{
    elapsed = 0;
    setFixedSize(840, 400);
    setAutoFillBackground(false);
}
//! [0]

//! [1]
void GLWidget::animate()
{
    elapsed = (elapsed + qobject_cast<QTimer*>(sender())->interval()) % 1000;
    repaint();
}
//! [1]

//! [2]
void GLWidget::paintEvent(QPaintEvent *event)
{
    QPainter painter;
    painter.begin(this);
    painter.setRenderHint(QPainter::Antialiasing);
    helper->paint(&painter, event, elapsed);
    painter.end();
}
//! [2]

Answer 1

尽管存在常见的误解，但这是 qdoc 语法，不是 doxygen。此注释用于 Qt 项目中的文档目的，以标记要呈现的示例片段。见 documentation和 corresponding code实现了这个功能。

作为 Qt 的最终用户，您不需要过多地处理它，除非您开始为 Qt 项目本身做出贡献，或者您正在尝试为自己的项目重用 qdoc，这在这一点上无疑是奇怪的。