2013-06-19 69 views
2

編程語言的編碼準則限制了行的長度,例如,到80個字符。我如何添加一個比Dxygen評論更長的URL?我如何告訴Doxygen需要連接多條線來形成實際的鏈接?如何打破Doxygen註釋中的長URL以滿足最大行長度?

實施例:

## 
# @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 

上面的例子不工作,並且它不工作或者結束與反斜槓線(反斜線只是複製到文檔)。

+0

只是一個想法,沒有真正的答案:使用網址縮短服務:) – Nippey

+0

使用URL縮短服務是一個很好的主意。不過,如果Doxygen可以做點什麼,會很有趣。 – holger

回答

0

您可以使用別名來簡化長的URL,即

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

,並在規定的Doxyfile

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

我希望在代碼中包含網址。我希望有一個續行機制(大多數編程語言的行尾都有反斜槓)。如果代碼被編輯,程序員必須通過別名找到Doxyfile來查找URL。該鏈接僅在代碼文檔中起作用。 – holger

1

,您可以嘗試這種方式。它爲我工作。不過,我不是100%肯定會爲你工作。我們的IDE使用空格作爲縮進而不是製表符。所以當你打破這條線,因此鏈接,它可能無法正常工作。

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

+1

這打破了生成的HTML文檔中的URL,但它適用於我測試過的瀏覽器。我不確定LaTeX和PDF等其他輸出格式。 – holger

+0

是的,你應該明確地做一些測試,我通常只看HTML輸出,也許LaTex和/或PDF有一些缺陷 – aldr