[C#] doxygen, Problem mit code-Tags

Programmiersprachen, APIs, Bibliotheken, Open Source Engines, Debugging, Quellcode Fehler und alles was mit praktischer Programmierung zu tun hat.
Antworten
Benutzeravatar
BeRsErKeR
Establishment
Beiträge: 689
Registriert: 27.04.2002, 22:01

[C#] doxygen, Problem mit code-Tags

Beitrag von BeRsErKeR »

Hallo,

ich erzeuge aus meinen C#-XML-Kommentaren (welche ich auch für IntelliSense nutze) eine kleine Docu. Funktioniert auch super. Mit externem CSS sehen sogar die Beispiele in den <code>-Tags gut aus. Allerdings scheint doxygen irgendwie verbuggt zu sein, da nicht alle <code>-Tags in korrektes HTML umgewandelt werden. Ich habe z.B. zwei Funktionen, die sich nur in den Parametern unterscheiden. Die XML-Kommentare unterscheiden sich dadurch nur geringfügig. Beide enthalten das selbe Beispiel in <code>-Tags. Bei einem wird es korrekt dargestellt, beim anderen wird nur die Schriftart geändert, aber der gesamte Text bleibt direkt im Fließtext ohne Rand usw.

Im fertigen HTML werden die ersten <code>-Tags in <div>'s mit eingebetteten <span>'s mit entsprechenden Klassen für die Formatierung umgewandelt. Im zweiten Fall werden aus den <code>-Tags einfach ein <p> mit einem <code> drin.

Ich kann mir nicht erklären, wodurch so etwas zustande kommt. Hat damit jemand Erfahrung? Google scheint auch nichts zu wissen. Mit anderen Tools wie Sandcastle, NDoc usw hatte ich leider keinen Erfolg. Entweder brauchen die Net 4.0, was ich nicht nutzen/installieren kann (Arbeitsrechner) oder sind nur bis Net 1.1 kompatibel (ich brauche Net 3.5). DocProject schmiert einfach mit einer Exception beim Starten ab.

Wichtig ist, dass ich direkt die XML-Kommentare nutzen kann, denn ich habe keine Zeit nochmal separat doxygen-Kommentare einzubauen. Die XML-Kommentare brauche ich ja eh für IS.

Ich nutze doxygen 1.8.2.
Ohne Input kein Output.
Benutzeravatar
dowhilefor
Moderator
Beiträge: 173
Registriert: 27.02.2009, 15:44
Alter Benutzername: 6SidedDice
Echter Name: Nico Probst
Wohnort: Bochum
Kontaktdaten:

Re: [C#] doxygen, Problem mit code-Tags

Beitrag von dowhilefor »

Kurze Frage: Was war das Problem bei Sandcastle? Ich benutze das sehr gerne und ich bin momentan auch noch an 3.5 gebunden, hatte damit keine Probleme.
Mein Gehirn besteht nur noch aus einem hash-index, ich weiss was ich kenn aber kenn nicht was ich weiss
Benutzeravatar
BeRsErKeR
Establishment
Beiträge: 689
Registriert: 27.04.2002, 22:01

Re: [C#] doxygen, Problem mit code-Tags

Beitrag von BeRsErKeR »

dowhilefor hat geschrieben:Kurze Frage: Was war das Problem bei Sandcastle? Ich benutze das sehr gerne und ich bin momentan auch noch an 3.5 gebunden, hatte damit keine Probleme.
Ich hatte einfach viel ausprobiert und die neuste Sandcastle-Version brauchte halt NET4.0. Ich guck mich mal nach ner älteren Version um. Das doxygen-Problem scheint wohl ein Bug zu sein.

Nachtrag: Habe nun Sandcastle getestet. Musste allerdings die Version 1.9.1.0 vom Juli 2010 nehmen. Die Hilfe sieht nach MSDN aus, was ich persönlich nicht so toll für eine kleine Bibliotheken-Docu finde. Außerdem braucht er mehrere Minuten für die Generierung (doxygen braucht 5 Sekunden). Und die Beispiele sind noch mehr vermurkst als bei doxygen. Keine Zeilenumbrüche, keine Einrückungen, keine Farben. Ziemlich häßlich alles. Bin also etwas enttäuscht.
Ohne Input kein Output.
Antworten