7

编程语言的编码准则限制行长，例如 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

上面的例子不起作用，用反斜杠结束行也不起作用（反斜杠只是复制到文档中）。

4

3 回答 3

3

你可以这样试试。它对我有用。但是，我不能 100% 确定它会为您工作。我们的 IDE 使用空格作为缩进而不是制表符。因此，当您中断线路，因此链接，它可能无法正常工作。

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

于 2013-06-26T15:00:07.267 回答
2

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

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

并在 Doxyfile 中定义

ALIASES = longurl="http://some.host.some.domain/and_here/..."
于 2013-06-19T21:53:29.653 回答
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 放在与链接文本不同的行上，然后能够在/.

于 2019-02-11T19:47:48.280 回答