Doxygen C# XML 注释和泛型不会在 HTML 输出中生成链接
-
12-12-2019 - |
题
我在网上找不到任何相关信息,而且我对 doxygen 中的 XML 注释支持一无所知。
我的问题很简单:
/// <see cref="GenericClass{TTypeparam}"/>
在我看来,这是在 XML 注释中引用开放泛型的正确方法,不会在 doxygen 输出中生成链接。它只是将文本从 cref 属性复制到输出。
我知道在 doxygen 中从自定义页面链接到泛型可以使用 GenericClass<TTypeParam>
. 。这是一个已知的错误,还是我错过了一些明显的事情?
顺便提一句。我正在使用 doxygen 1.8.2
解决方案
Doxygen 不支持 { ..目前 cref 内的语法。您可以将其视为一个错误。请随意在 doxygen 的错误跟踪器中为此提交错误报告。
其他提示
Doxygen 目前似乎没有一个好的方法来处理泛型(在 1.8.8 中) - 除非您很高兴忘记 Microsoft 支持的标准 XML 格式(使用 {...} 语法)并切换使用“GenericClass”或“ ef GenericClass”(当然,这两者都是 Visual Studio 工具不喜欢的无效 XML)。
查看 doxygen 错误 https://bugzilla.gnome.org/show_bug.cgi?id=738173, https://bugzilla.gnome.org/show_bug.cgi?id=738167 和 https://bugzilla.gnome.org/show_bug.cgi?id=704090
不隶属于 StackOverflow