line - 在 doxygen 文档中如何创建指向文件特定行的链接

Question

有几个 doxygen 命令的目的是在文档中创建链接( @link ， @ref )。
我目前正在使用 @ref命令来创建一个自定义文件的链接，该文件是用 doxygen (xml) 不支持的语言编写的。
我想更改此链接，使其指向文件中的精确行。
是否有允许这样做的 doxygen 命令？

Answer 1

我不确定 \ref或 \link可以做到这一点。但是，如果可以的话，采用这种方法的一个问题是，如果您更改要链接到的文件的内容而不更改链接，则链接将变为无效。这是分离源代码和文档的问题之一。

为什么不在文档中包含您感兴趣的文件的特定部分，而不是链接到另一个文件中的特定行？你可以:

使用 \include 包含整个文件(还有 \includelineno )，只需在文本中引用它的相关部分(例如“下面代码中的函数 xxx”)，或

在文档中使用 \snippet 在需要引用它们的地方包含文件片段.

编辑 : 或者，您可以使用 \dontinclude 命令，连同 \line , \skip , \skipline , 和 \until命令允许您包含特定文件的特定行/块。请参阅 \dontinclude 中的示例文档。