Liberty
23-11-2006, 17:52
Moin,
ich muss im nächsten Semester eine Java-Projektarbeit auf einfachstem Niveau ablegen und da ich keine Lust habe, die 2567igste Implementierung von Reversi für Java abzugeben, habe ich mal ein wenig über mögliche "sinnvolle" Spielereien nachgedacht und ich bin da über eine Idee gestolpert, zu der ich einfach mal an dieser Stelle ein kleines Brainstorming bezüglich Machbarkeit und Sinnhaftigkeit starten wollte...
Ich bin schon seit einiger Zeit mit der Dokumentation per JavaDoc etwas unzufrieden. Klar, eigene Doclets schreiben wäre eine Möglichkeit, da Einfluss auf die Gestaltung und die Präsentationsform zu nehmen, aber alles in allem macht JavaDoc auf mich mittlerweile einen etwas betagten Eindruck.
Auf der anderen Seite gibt es ja nun seit Java 1.5 Annotations und jetzt bin ich am Überlegen, ob man nicht die Doc-Comments durch Annotations ersetzen könnte, z.B. statt dem @param-Tag im Doc-Comment eine @param-Annotation vor der entsprechenden Methode.
Vorteil wäre in meinen Augen, dass die Dokumentation auch im Kompilat erhalten bleibt und je nach Bedarf wieder ausgelesen und evtl. in andere Darstellungsformen überführt wird.
Der größte Nachteil, über den ich mir im Moment Gedanken mache, ist, dass der (Byte-)Code über ein vertretbares Maß hinaus aufgebläht würde und die Performance unter den dann natürlich massig vorhandenen Annotations leiden würde. Gibt's da irgendwelche Erfahrungswerte auf eurer Seite mit Annotations?
Dann habe ich noch eine rein praktische Frage: Hat der aktuelle Java-Compiler eine "IgnoriereAnnotations"-Option? Dann könnte man ja leicht auch weiterhin "undokumentierten" Code aus dokumentierten Quellen erstellen.
So long,
Liberty
P.S.:
Nicht vergessen, das hier ist eine Idee im Zusammenhang mit einem rein akademischen Projekt, das mir nicht zuletzt auch einfach einen Pflicht-Schein bringen soll, also ist die Hauptfrage dieses Threads wohl so etwas wie "Macht es Sinn, dieses Konzept einfach mal auszuprobieren?"
ich muss im nächsten Semester eine Java-Projektarbeit auf einfachstem Niveau ablegen und da ich keine Lust habe, die 2567igste Implementierung von Reversi für Java abzugeben, habe ich mal ein wenig über mögliche "sinnvolle" Spielereien nachgedacht und ich bin da über eine Idee gestolpert, zu der ich einfach mal an dieser Stelle ein kleines Brainstorming bezüglich Machbarkeit und Sinnhaftigkeit starten wollte...
Ich bin schon seit einiger Zeit mit der Dokumentation per JavaDoc etwas unzufrieden. Klar, eigene Doclets schreiben wäre eine Möglichkeit, da Einfluss auf die Gestaltung und die Präsentationsform zu nehmen, aber alles in allem macht JavaDoc auf mich mittlerweile einen etwas betagten Eindruck.
Auf der anderen Seite gibt es ja nun seit Java 1.5 Annotations und jetzt bin ich am Überlegen, ob man nicht die Doc-Comments durch Annotations ersetzen könnte, z.B. statt dem @param-Tag im Doc-Comment eine @param-Annotation vor der entsprechenden Methode.
Vorteil wäre in meinen Augen, dass die Dokumentation auch im Kompilat erhalten bleibt und je nach Bedarf wieder ausgelesen und evtl. in andere Darstellungsformen überführt wird.
Der größte Nachteil, über den ich mir im Moment Gedanken mache, ist, dass der (Byte-)Code über ein vertretbares Maß hinaus aufgebläht würde und die Performance unter den dann natürlich massig vorhandenen Annotations leiden würde. Gibt's da irgendwelche Erfahrungswerte auf eurer Seite mit Annotations?
Dann habe ich noch eine rein praktische Frage: Hat der aktuelle Java-Compiler eine "IgnoriereAnnotations"-Option? Dann könnte man ja leicht auch weiterhin "undokumentierten" Code aus dokumentierten Quellen erstellen.
So long,
Liberty
P.S.:
Nicht vergessen, das hier ist eine Idee im Zusammenhang mit einem rein akademischen Projekt, das mir nicht zuletzt auch einfach einen Pflicht-Schein bringen soll, also ist die Hauptfrage dieses Threads wohl so etwas wie "Macht es Sinn, dieses Konzept einfach mal auszuprobieren?"