Ich bin nur mit dem No-Frills-Javadoc-Generator vertraut, möchte jedoch einige mathematische Gleichungen in mein Javadoc aufnehmen (anstatt ständig auf ein anderes Dokument zu verweisen).Javadoc mit Gleichungen?
Gibt es eine bequeme Möglichkeit so etwas wie include/richtig machen LaTeX zu tun (am meisten bevorzugt - dann konnte ich nur Cut-n-Paste) oder MathML-Tags?
Während ich es nicht persönlich getan haben, gibt es Möglichkeiten, um Ihre eigene mit dem Doclet oder Taglet API erstellen Sie Ihre eigenen Doclet oder Taglet zu erstellen. Einige davon wurden bereits nach einer Schnellsuche gemacht, die ein solches Beispiel liefert: http://www.ohloh.net/p/latextaglet
Wenn Sie sich wagemutig genug fühlen, ist das Latextaglet-Projekt Open Source, so dass Sie es vielleicht noch weiter an Ihre Bedürfnisse anpassen können.
Auschecken Doxygen.
Es ist extrem schnell, frei und LaTeX eingebettet unterstützt.
Ich stocherte ein bisschen herum; Die LaTeX-Option wird anscheinend nur beim Generieren der ps/pdf-Dokumentation unterstützt. Gibt es eine Möglichkeit, das konventionelle Stil-Javadoc (das ich sehr mag) mit Bildern zu erzeugen, die aus LaTeX-Embedded generiert wurden? Ich kann mit einer kleinen Konfiguration umgehen, aber ich möchte meinen Dokumentationsgenerator nicht programmieren. – Carl
Doxygen wird LaTeX auch in generierte HTML-Dokumentation mit Bildern einbetten. Ich habe dies vor kurzem mit Doxygen auf meinem Code bestätigt. – nsanders
hrm, irgendwelche Vorschläge für Starter-Informationen über die Anpassung der Javadoc-Ausgabe? wie in, wo ich anfangen könnte, überhaupt darüber nachzudenken, wie js zu dem hinzuzufügen, was das javadoc tool produziert? – Carl
@Carl, [dieser Blog-Beitrag] (http://zverovich.net/2012/01/14/beautiful-math-in-javadoc.html) beschreibt, wie Sie das MathJax-JavaScript in die HTML-Dateien einfügen. Es scheint, dass das alles ist, was erforderlich ist. –
Sie erkennen, dass dieser Thread fast fünf Jahre alt ist. Ich bezweifle, dass @Carl sucht. – duffymo