在doxygen文檔中如何創建指向文件特定行的鏈接

有幾個doxygen命令，其目的是在文檔中創建鏈接（@link，@ref）。
我正在使用@ref命令來創建一個到doxygen（xml）不支持的語言編寫的自定義文件的鏈接。
我想改變這個鏈接，以便它指向文件中的一個精確的行。
是否有一個doxygen命令可以做到這一點？在doxygen文檔中如何創建指向文件特定行的鏈接

來源

2012-03-12 wil

我不確定\ref或\link可以做到這一點。但是，如果可以的話，採用這種方法的一個問題是，如果您更改鏈接文件的內容而無需更改鏈接，鏈接將變爲無效。這是分離源代碼和文檔的問題之一。

而不是鏈接到另一個文件中的特定行，爲什麼不包含您在文檔中感興趣的文件的特定部分？你既可以：

包括與\include整個文件（也有\includelineno），只是引用它的相關部分的文本（例如「在對碼功能XXX下方」），或
包括片段您需要在文檔中使用\snippet來引用它們。

編輯：此外，還可以使用\dontinclude命令，它連同\line，\skip，\skipline和\until命令允許包括特定行/特定文件的塊。請參閱\dontinclude文檔中的示例。

來源

2012-03-12 10:41:28 Chris

感謝您的建議。 '\ snippet'命令看起來很有前途，但它只適用於_source files_中的代碼片段，而我想從_xml資源file_中顯示數據。我無法將標識片段位置的標籤添加到我的xml文件，因爲doxygen樣式的評論會「破壞」它。使用\ include也很聰明，但它是一個巨大的文件，我不想每次都包含它（文檔會被無關的數據弄髒）。但是，當我使用\ ref到我的文件時，我已經參考了相關的部分，正如你所建議的那樣。我只是在尋找更好的方法。 – wil 2012-03-13 01:30:06

@wil沒問題。我還在'\ dontinclude'命令中添加了一個註釋，這比''snippet'命令更適合你，因爲它不需要將任何標記添加到資源文件中。然而，根據文檔，似乎這個命令只適用於源文件（我沒有測試過這個，所以我不確定這是否是實際情況）。您也可以直接在您的文檔中包含XML。如果做不到這一點，恐怕你只能忍受使用'\ ref'方法。 – Chris 2012-03-13 08:05:52

我試過'\ dontinclude'命令，它也適用於xml文件！我已解決這個解決方案，並將您的答案設置爲「接受」:-) – wil 2012-03-13 09:09:14

在doxygen文檔中如何創建指向文件特定行的鏈接

回答

相關問題