Question

编程语言的编码指南限制了行长，例如：到80个字符。如何在Doxygen评论中添加超过该限制的URL？如何告诉Doxygen要连接多条线以形成实际链接？

示例：

##
# @file  mycode.py
# @sa    See the documentation: http://some.host.some.domain/and_here
#        _we_have_a_very_long_URL_that_can_not_be_written_in_one_line
#        _because_it_would_exceed_the_line_length_limit

上面的示例不起作用，并且它不能用反斜杠结束行（反斜杠只是复制到文档中）。

Answer 1

你可以这样试试。它对我有用。但是，我不是100％肯定它会为你工作。我们的IDE使用空格作为缩进而不是制表符。因此，当你打破这条线，因此链接时，它可能无法正常工作。

<a href="http://stackoverflow.com/questions/9098680/
doxygen-link-to-a-url-oesnt-generate-the-link-correctly">
link
</a>

Answer 2

这是执行死刑的一个老问题。我正在回答C ++样式的注释。但是，如果您以以下形式链接：

/** 
 * [link_text](http://foo.com/bar/baz/qux/wibble/flob?id=deadbeef123456789abcdefghijklmnopqrstuvwxyz)
 */

您可以通过以下方式包装该URL，并且生成的HTML输出仍将包含有效的定位标记：

/**
 * [link_
text]
(http://foo.com/bar/baz/qux/wibble/
flob?id=deadbeef123456789abcdefghijklmnopqrstuvwxyz)
 */

显然，这可能会使注释块的可读性降低。但这使您对可能的想法有所了解。在这里具有优势的主要事情是能够将URL与链接文本放在单独的行上，然后能够在/之后至少包装一次。

Answer 3

您可以使用别名来缩写长网址，即

##
# @file  mycode.py
# @sa    See the documentation: @longurl

并在Doxyfile中定义

ALIASES = longurl="http://some.host.some.domain/and_here/..."

如何在Doxygen注释中断开长URL以满足最大行长度？

3 个答案: