Hallo,
bin ich der einzige Programmierer, dem es nicht gefällt, dass man für Javadoc Html Tags braucht?
Gut, der Vorteil ist, man kann sehr ausführlich seine Javadoc designen, mit Tabellen, Bildern, usw. Aber ein gravierender Nachteil ist wohl, dass man ein extra Programm braucht um das geschriebene Javadoc lesen zu können. Bei fast allen Javadocs im JDK sind überall die Html-Tags, so dass man nur sehr schwer was lesen kann.
Z.B:
Wieso wurde nicht eine leichte Formatierung gewählt, wie z.B. in Org-Mode von Emacs? Im Org-Mode kann ich Text, Tabellen und Listen formatieren, aber der Text bleibt dabei vollständig lesbar.
Da man mit dem jetzigem System eh ein Anzeige-Programm braucht (z.B. einen Web-Browser), hätte man Links, Tabellen und Hervorhebungen doch dem Anzeige-Programm überlassen können. Anstelle das man schreiben muss
, hätte man das auch so lösen können:
Dazu kommt noch, dass Html schreiben eine Qual ist. Somit brauche ich ein extra Programm um a) Javadoc zu schreiben und b) Javadoc zu lesen.
Ich kann mir einfach nicht vorstellen, dass sich keine Programmierer die Frage stellen wieso wir Html Tags für Javadoc verwenden.
Kann man irgendwas anderes verwenden und wird es verwendet, oder sind alle mit den Html-Tags und dem Zwang einen Html-Editor und Html-Anzeige benutzen zu müssen zufrieden?
bin ich der einzige Programmierer, dem es nicht gefällt, dass man für Javadoc Html Tags braucht?
Gut, der Vorteil ist, man kann sehr ausführlich seine Javadoc designen, mit Tabellen, Bildern, usw. Aber ein gravierender Nachteil ist wohl, dass man ein extra Programm braucht um das geschriebene Javadoc lesen zu können. Bei fast allen Javadocs im JDK sind überall die Html-Tags, so dass man nur sehr schwer was lesen kann.
Z.B:
HTML:
embedded in the message pattern is specified (<b>()?</b> signifies optionality):<br /><code>{</code><i>argument-number</i><b>(</b><code>,</code><i>format-name</i><b>(</b><code>,</code><i>format-style</i><b>)?)?</b><code>}</code>
Wieso wurde nicht eine leichte Formatierung gewählt, wie z.B. in Org-Mode von Emacs? Im Org-Mode kann ich Text, Tabellen und Listen formatieren, aber der Text bleibt dabei vollständig lesbar.
Da man mit dem jetzigem System eh ein Anzeige-Programm braucht (z.B. einen Web-Browser), hätte man Links, Tabellen und Hervorhebungen doch dem Anzeige-Programm überlassen können. Anstelle das man schreiben muss
HTML:
<ul><li>Eins</li><li>Zwei</li><li>Drei</li></ul>
Code:
* Eins
* Zwei
* Drei
Dazu kommt noch, dass Html schreiben eine Qual ist. Somit brauche ich ein extra Programm um a) Javadoc zu schreiben und b) Javadoc zu lesen.
Ich kann mir einfach nicht vorstellen, dass sich keine Programmierer die Frage stellen wieso wir Html Tags für Javadoc verwenden.
Kann man irgendwas anderes verwenden und wird es verwendet, oder sind alle mit den Html-Tags und dem Zwang einen Html-Editor und Html-Anzeige benutzen zu müssen zufrieden?