Diskussion:Doxygen

aus Wikipedia, der freien Enzyklopädie
Letzter Kommentar: vor 1 Jahr von Haraldmmueller in Abschnitt Doxy-Dokumentation?
Zur Navigation springen Zur Suche springen

Die Tabelle mit den Versionen ist ziemlich aussagelos. Habe sie entsprechend gelöscht. Herrn 09:41, 1. Sep 2005 (CEST)

Sicherlich wird eine Seite durch die Auflistung aller Versionen schnell unübersichtlich, diese Informationen deshalb gleich komplett zu entfernen ist jedoch ein Verlust dieser unter Aufwand zusammengesuchten Informationen. Um hier einen fairen und sinnvollen Mittelweg zu finden habe ich die Tabelle mit den Versionen auf eine "Unterseite" gestellt, wie es im Artikel Zusatztabellen für derartige Kandidaten vorgeschlagen wird. (-- Ebartels 14:37, 2. Sep 2005 (CEST))

Doxygen ist nicht nur "ein freies Softwareprojekt". Das Programm ist DAS Tool, um zum Beispiel in C++-Projekten (und einer ganzen Reihe weiterer Sprachen) eine ordentliche, umfassende Quellcodedokumentation zu erstellen. Ich stimme daher gegen den Löschantrag. Die Versions-Historie ist IHMO dagegen wirklich nicht sonderlich nutzbringend in einer Enzyklopedie.

-- Martin Fuchs 12:41, 21. Okt 2005 (CEST)

Ich denke, dass die Seite nicht gelöscht werden sollte, da Doxygen nicht nur ein Softwareprojekt ist, wie bereits von Martin Fuchs erwähnt, sondern mittlerweile als ein fester Bestandteil von agilen Prozessen in der Softwareentwicklung angesehen werden kann. Vielleicht sollte man dazu den Beitrag erweitern und auch in der Beschreibung zum Agilen Prozess einen entsprechenden Verweis setzen. Das wäre mein Vorschlag. Auf jeden Fall bin ich gegen die Löschung dieses Artikels.

Sorry, war eben gerade nicht angemeldet, da ich mich an einem anderen Computer befinde.

--Rafael Bugajewski 14:32, 24. Okt 2005 (CEST)

Kritik an Softwaredokumentationswerkzeugen[Quelltext bearbeiten]

ich bin der meinung das man durch die starke kommentierung den code vor lauter kommentaren nicht mehr sieht. ist diese kritik begründet? -- Qopep 19:34, 19. Feb 2006 (CET)

absolut. was ist überhaupt der sinn des folgenden satzes hier?: "Zu beachten ist, dass Programm-Dokumentationen für Entwickler resultieren und nicht als Benutzerhandbücher geeignet sind." -- Watzlaf
ich denke das soll klar davon abgrenzen, dass mit einem dokumentationswerkzeug keine benutzerdokumentation erstellt werden kann. das wäre aber bei Software-Dokumentationswerkzeug besser aufgehoben. ich schmeiss ihn mal raus und füg die kritik hinzu. -- Qopep 09:24, 4. Mär 2006 (CET)
nachtrag: okay, jetzt versteh ichs. bei Software-Dokumentationswerkzeug steht: "Die Dokumentation ist dabei jedoch keinesfalls nur auf den Quellcode beschränkt". -- Qopep 10:10, 4. Mär 2006 (CET)
absolut nicht. Eine detailierte Beschreibung jeder Programmstruktur (Klasse, Methode, Funktionen etc.) im Quelltext selbst (in Kommentaren) ist unabdingbar. Diese nun so zu formulieren, dass ein Programm eine Dokumentation daraus erstellen kann ist praktisch. Zugegebenerweise ist eine gute Quelltextformatierung einzuhalten um den Quelltext lesbar zu halten. IDEs unterstützen in der Regel solche Dokumentierungswerkzeuge durch Syntaxhighlighting wodurch der Quelltext durchaus besser lesbar ist wie ohne solche 'doxygen' tags (Bei gleichem Kommentierungsumfang). --Maexs 20:41, 9. Feb. 2008 (CET)Beantworten

Auflistung der Commands[Quelltext bearbeiten]

Wäre es in irgendeiner Weise sinnvoll, die wichtigsten Doxygen-Commands hier kurz anzugeben oder zumindest direkt auf eine (ausführliche) Referenz zu verweisen? Immerhin erscheint dieser Artikel bei einer großen Suchmaschine an erster Stelle, wenn man nach dem Begriff "doxygen" sucht, aber eigentlich eine Referenz finden möchte. Als solche bietet sich etwa [1] an (das manuelle Durchklicken kann da bereits etwas mühsam und umständlich sein). Dies nur so als Vorschlag. --Stultissimum 01:10, 1. Jun 2006 (CEST)

Wichtiger wäre ein Beispiel wie in en:Doxygen. Erst dann wäre eine Tabelle mit den wichtigsten Commands (wie in Javadoc) sinnvoll, ohne ein Beispiel wäre aber unverständlich, was man mit den Commands machen soll (für jemanden, der Doxygen noch nicht kennt). Einen Link auf die Kommandoreferenz halte ich auch nicht für notwendig, da das aus dem Zusammenhang gegriffen wäre (durch den Link auf doxygen.org kommt man ja auch zur Dokumentation, die Kommandoliste ist ja nur ein Teil davon). Nur einen Link zu haben, um Klickarbeit zu ersparen, ist nicht der Sinn der Wikipedia. -- Memset 10:30, 1. Jun 2006 (CEST)
Ich habe mal ein simples C Beispiel eingefügt; c++ wie in en:Doxygen halte ich für übertrieben, da unerfahrene Programmierer überfordert sein könnten und es lediglich um das Prinzip geht.
Eine Auflistung der Befehle halte ich für ungünstig; Wikipedia sollte nicht als Programm-Hilfe/Howto dienen sonder lediglich als Beschreibung; "Was ist Doxygen". Btw.: Doxygen selbst liefert eine extrem gute Dokumentierung der Befehle/tags/etc. Dass Wikipedia an erster Stelle bei Google auftaucht liegt an den Google-Algorithmen, die die Hohe verlinkung innerhalb besser bewerten als die doxygen-seite selbs. Dein Link ist auch nur die Doxygen-eigene Dokumentation die sich (zumindest unter Linux) bei der Installation auf deinem Rechner befindet ;)
--Maexs 23:35, 22. Jan. 2008 (CET)Beantworten
Die Doxygen-Commands scheinen ja weitgehend eine Obermenge der Javadoc-Kommandos zu sein (mit Ausnahme von {@inheritDoc} und {@link reference}, die anders realisiert sind). Dann könnte man die Empfehlung formulieren, Javadoc-kompatible Tags mit @ zu notieren (bzw. jeweils die Javadoc-kompatible Version zu wählen, z. B. @throws anstelle von \throw) und die anderen mit Backslash, bzw. hierfür ein kurzes Beispiel angeben; solchermaßen dokumentierter Code könnte sowohl (optimalerweise) von Doxygen als auch (mit einer Basisfunktionalität) von Javadoc ausgewertet werden. --Tobias 19:36, 10. Jun. 2008 (CEST)Beantworten

Ständige Eigenwerbung[Quelltext bearbeiten]

Leider versucht ein gewisser Herr Blatz (91.45.2*.*) ständig seine eigenen Seiten im Artikel zu verlinken.

... und schon wieder wird auf seine private Seite verlinkt!(nicht signierter Beitrag von 79.199.44.26 (Diskussion) )

Mit ausführlicher Begründung kannst Du bei WP:Vandalen sicher auch um eine Aufnahme der Adresse in die Blockliste erbitten. --Biezl  15:59, 24. Aug. 2008 (CEST)Beantworten

PDF als Ausgabeformat[Quelltext bearbeiten]

Hallo,

ich habe nirgends bei Doxygen (Version 1.8.5) PDF als Ausgabeformat gefunden. Es ist zwar beschrieben wie man aus Latex ein PDF erstellt. Aber das Ausgabeformat ist Latex bzw. pdflatex und nicht PDF. (nicht signierter Beitrag von 62.152.181.34 (Diskussion) 10:30, 26. Aug. 2013 (CEST))Beantworten

Hi,
das stimmt natürlich. Postscript, PDF und DVI lassen sich nur über LaTeX als Zwischenformat erzeugen. Der ganze Abschnitt Unterstützte Ausgabeformate müsste mal etwas überarbeitet werden. Er unterschlägt, vermutlich weniger genutze, Ausgabeformate (Docbook, AutoGen, PerlMod) und behauptet (IMHO) fälschlicherweise, Markdown wäre ein Ausgabeformat. Doxygen erlaubt die Verwendung von Markdown als Eingabeformat innerhalb der Codedokumentation.
--InfoBroker2020 10:47, 18. Mär. 2015 (CET)Beantworten

Doxy-Dokumentation?[Quelltext bearbeiten]

Da steht:

Mithilfe einer Doxy-Dokumentation ist ...

Was ist eine Doxy-Dokumentation? --Haraldmmueller (Diskussion) 14:33, 18. Aug. 2022 (CEST)Beantworten