如何突破长URL在Doxygen的意见,以满足最大行长度?

问题描述 投票:3回答:3

编程语言的编码规则限制的线长,例如80个字符。如何添加URL是长于限制Doxygen的意见吗?我怎么告诉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

上面的例子中不起作用,并且它不工作或者结束与反斜杠线(反斜线只是复制到文档)。

doxygen
3个回答
1
投票

你可以尝试这种方式。它为我工作。不过我不是100%肯定它会为你工作。我们的IDE使用空格作为缩进,而不是标签。所以,当你打破了线,因此链接,它可能无法正常工作。

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


1
投票

这是执行巫术的老问题。我回答了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)
 */

显然,这可能使注释块的可读性。但是,这给你什么是可能的想法。是advantagious这里主要的事情是能够把URL从链接文本单独的行,然后能够一/后至少一次包裹。


0
投票

您可以使用别名来简写长的URL,即

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

而在定义的Doxyfile

ALIASES = longurl="http://some.host.some.domain/and_here/..."
© www.soinside.com 2019 - 2024. All rights reserved.