Wie kann man lange URLs in Doxygen-Kommentaren umbrchen, um die maximale Zeilenlänge zu erfüllen?

Question

Die Codierungsrichtlinien der Programmiersprache begrenzen die Zeilenlänge, z.B. auf 80 Zeichen. Wie kann ich eine URL zu Doxygen-Kommentaren hinzufügen, die länger als diese Grenze ist? Wie sage ich Doxygen, dass mehrere Zeilen verbunden werden sollen, um den tatsächlichen Link zu bilden?

Beispiel:

##
# @file  mycode.py
# @sa    Siehe die Dokumentation: 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

Das obige Beispiel funktioniert nicht, und es funktioniert auch nicht, die Zeilen mit einem Backslash zu beenden (der Backslash wird einfach in die Dokumentation kopiert).

Answer 1

Sie können es auf diese Weise versuchen. Es hat bei mir funktioniert. Allerdings bin ich mir nicht zu 100 % sicher, ob es bei Ihnen funktionieren wird. Uns

Answer 2

Sie könnten ein Alias verwenden, um die lange URL abzukürzen, z.B.

##
# @file  mycode.py
# @sa    Siehe die Dokumentation: @longurl

und in der Doxyfile definieren

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

Answer 3

Dies ist die Ausführung der Totenbeschwörung für eine alte Frage. Ich antworte für C ++ -Style-Kommentare. Aber wenn Sie Ihren Link in der Form machen:

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

Sie können diese URL auf folgende Weise umschließen, und die generierte HTML-Ausgabe enthält immer noch ein funktionierendes Anker-Tag:

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

Offensichtlich kann dies den Kommentarblock weniger lesbar machen. Aber dies gibt Ihnen eine Vorstellung davon, was möglich ist. Die Hauptvorteile hier sind die Möglichkeit, die URL von dem Link-Text zu trennen und sie dann mindestens einmal nach einem / zu umschließen.