Gibt es ein Tool, das javadoc durch etwas ersetzt, das mehr Syntax im Wiki-Stil als die HTMLish-Syntax von normalem JavaDoc ist?Gibt es einen Javadoc-Ersatz, der eine Wiki-ähnliche Syntax verwendet?
Eines meiner Probleme ist, dass ich JavaDoc hauptsächlich in Quellform gelesen habe. Selbst für externe Bibliotheken versuche ich, die Quelle anzuhängen, damit ich von meiner IDE aus in die Dokumentation einsteigen kann, indem ich die Dokumentation über dem Einstiegspunkt und ggf. den Code unten überprüfe.
Das andere Problem ist, dass Dinge wie Listen und Codebeispiele sind chaotisch zu schreiben, vor allem, wenn Ihre IDE darauf besteht, Sterne in jeder Zeile setzen. Was ich möchte, ist zu sehen, etwas, das eine Art von Wiki-Syntax mit mindestens folgenden Merkmalen verwendet:
- Listen
- Codeblöcke
- Vernetzung zu Methoden/Klassen
Es gibt viel mehr Dinge, die schön wären, aber ich glaube, das sind die wesentlichen Dinge.
Kennt jemand solch ein Werkzeug?
Codeblöcke sind nicht schlecht mit '{@code}'. Ich denke, '{@link}' funktioniert ziemlich gut, um auf Mitglieder und Typen zu verweisen. –
während du über Wiki-style-Display nachdenkst, wäre es schön, wenn du es auch im Wiki-Stil bearbeiten könntest und es zurück in die Kommentare schiebst. Ich vermute, das fragt ein bisschen nach. – Carl