Dokumentation
-
Optimizer, der Wichser schrieb:
habe ein paar Dokumentationen im Internet gesehen und die schauen IMO wirklich nicht besonders gut aus, im Vergleich.
Depp.
-
also mir gefällt doxygen - http://projekte.schornboeck.net/cppgi/doc/
ich würde das tool aber nicht nach dem aussehen auswählen, sondern nach der leistung...
-
genau!
@Shade of Mine hast du schonmal effektiv c++ gelesen?00070 #define BYTES_TO_DWORD(strptr) \ 00071 (((dword) *((strptr)+3) << 24) | \ 00072 ((dword) *((strptr)+2) << 16) | \ 00073 ((dword) *((strptr)+1) << 8) | \ 00074 ((dword) *(strptr)))
-
Wichser schrieb:
Wenn du als Beispiel eine Dokumentation undokumentierten Code bringst, dann ist das nicht sehr aussagekräftig.
Guck dir hier mal die Dokumentation der String klasse an und vergleiche sie mit der CString-Klasse hier. Du wirst feststellen, dass sich zwar das "Grundgerüst" der Darstellung ähnelt, man aber nicht viel mehr über dieses cppdoc-Tool sagen kann, weil einfach nur das Grundgerüst vorhanden sind. Die Zusammenfassung der Methoden in der Javadoc-Doku erscheint hier schon deutlich aussagekräftiger als die Detaildarstellung bei dem cppdoc-Tool.
Mit anderen Worten: Bring mal ein vernünftiges Beispiel. Das, was du gebracht hast, ist Mist.
-
Bei doxygen ist auf jeden Fall geil das es soviele Ausgabeformate beherrscht. CHM ist einfach Super!!
-
Es stellt sich auch die Frage, inwiefern ein Doku-Tool für C++ überhaupt ein vernünftiges Ergebnis liefern kann. IMHO ist so eine Darstellung, wie sie Javadoc oder cppdoc liefern nicht für C++-Code angemessen. Diese Darstellung geht von objektorientiertem und nur objektorientiertem Code aus. C++ ist aber eine Multiparadigmensprache und nicht nur eine objektorientierte Sprache. Man hat in C++ starke Anreize nicht objektorientiert, sondern entsprechend eines anderen Paradigmas zu programmieren. Wie sieht denn dann die Dokumentation aus? Ich habe da in diesem cppdoc-Beispiel von oben nichts gefunden.
-
dW2 schrieb:
genau!
@Shade of Mine hast du schonmal effektiv c++ gelesen?00070 #define BYTES_TO_DWORD(strptr) \ 00071 (((dword) *((strptr)+3) << 24) | \ 00072 ((dword) *((strptr)+2) << 16) | \ 00073 ((dword) *((strptr)+1) << 8) | \ 00074 ((dword) *(strptr)))schau dir doch mal den Header der datei an:
AUTHOR: Antoon Bosselaers, ESAT-COSICich hab die datei nur n bisschen angepasst
irgendwann schreib ich mal ne eigene version, aber momentan tut es die auch.
-
@Gregor: Das mit der Dokumentation um String war jetzt natürlich mies. Der Quellcode der String-Klasse in Java besteht zu 80% aus Dokumentation.
Außerdem geht es mir ja jetzt nicht um die Dokumentation, sondern um das Tool, und auf den ersten flüchtigen Blick scheint es mir ähnlich mächtig zu sein.
Aber natürlich klar, wahrscheinlich nützt das Tool nur wirklich was, wenn man in C++ objektorientiert programmiert.
-
Optimizer schrieb:
Außerdem geht es mir ja jetzt nicht um die Dokumentation, sondern um das Tool, und auf den ersten flüchtigen Blick scheint es mir ähnlich mächtig zu sein.
Nach meinem ersten flüchtigen Blick kann ich das nicht behaupten. Da bei dem C++ Beispiel einfach keine Dokumentation vorhanden ist, kann man auch nichts zur Darstellung, Verlinkung usw. der Dokumentation sagen. Es ist nur ein Grundgerüst zu sehen. Das ist mir ehrlich gesagt zu wenig, um etwas beurteilen zu können.
-
Ich hab mir CSocket angeschaut und die Verlinkung scheint eigentlich schon zu passen (man beachte vor allem den Punkt "Methods inherited from class CAsyncSocket"
).Aber irgendwas stört mich, ich weiss es nicht genau... vielleicht ist es einfach nur die hässliche Namensgebung.
-
Bei Socket kann ich in diesem cppdoc-Beispiel auch keinerlei Dokumentation entdecken. Vergleich das mal mit der Dokumentation von Socket aus der Java Standardbibliothek. Die Detail-Ansicht der Methoden-Dokumentation ist wieder leer und es ist nur ein Doku-Grundgerüst zu sehen.
-
Gibt es sowas auch für C# ??
