QT特别评论//:// [num]等

时间:2011-07-07 08:14:07

标签: c++ qt comments

qt examples文件夹中的这个特殊注释是什么意思?

我知道“//:”如果下一行包含tr(“”),这是对翻译程序的评论。

// []之间的代码似乎是生成的html文档。

是否有完整描述特殊评论的文件?

2 个答案:

答案 0 :(得分:5)

Qt在其代码注释中使用了Doxygen Special Commands。 [好吧,为了正确,Doxygen扩展了Qt的注释特殊命令。]特殊命令用于控制文档在代码上运行时的生成。维护Qt的Trolls拥有自己的工具,用于从代码生成文档。 Doxygen是为了给我们凡人提供我们可以使用的工具而编写的。

使用Doxygen(我假设使用Qt的工具)可以做的一件事就是在文档中包含示例代码。通常,只需要部分代码,因此可以使用一些特殊命令来控制文件的哪个部分显示(例如 \line)。他们依赖于在代码中查找标记。恕我直言,// [xx]只是那些标记。

答案 1 :(得分:1)

This is the document for translation comments,虽然没有提及//[num] ....