//! [0] 在Qt源代码中的含义是什么?

22

//! [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]

1
它们只是注释。 - billz
5
可能是为了文档目的。 - chris
1个回答

31

常见误解是,这是 qdoc 语法,而不是 doxygen。此注释用于 Qt 项目的文档目的,以标记要呈现的示例片段。请参见文档和实现此功能的相应代码

作为 Qt 的最终用户,您不需要过多处理它,除非您开始为 Qt 项目本身做贡献,或者您正在尝试为自己的项目重用 qdoc,但此时这样做可能会有点奇怪。


网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接