//![0] 在 Qt 源代码中 [英] //! [0] in Qt source code

问题描述

是什么意思//！[n] (n = 0, 1, 2 ...) Qt 示例项目中 C++/QML 源代码中的标记?

What is the meaning of the //! [n] (n = 0, 1, 2 ...) markup in the C++/QML sources in the Qt sample projects?

例如:

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

推荐答案

尽管存在常见的误解，但这是 qdoc 语法，不是 doxygen.此注释用于 Qt 项目中的文档目的，以标记要呈现的示例片段.请参阅文档和对应代码，实现了这个功能.

Despite the common misconception, this is qdoc syntax, not doxygen. This comment is for documentation purposes in the Qt Project to mark example snippets to be rendered so. See the documentation and the corresponding code that implements this feature.

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

As an end user of Qt, you do not need to deal with it too much unless you start contributing to the Qt Project itself or you are trying to reuse qdoc for your own project, which would be admittedly odd at this point.

这篇关于//![0] 在 Qt 源代码中的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！