[C#] doxygen, Problem mit code-Tags
Verfasst: 07.09.2012, 12:47
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.
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.