search

LarsHaalck / SOPRA

SOPRA und so
1 stars 1 forks source link

Javadoc auch für private Methoden #29

Closed LarsHaalck closed 9 years ago

LarsHaalck commented 9 years ago

Wir haben glaube ich bis jetzt alle Methoden mit javadoc kommentiert, also auch private. Eigentlich genertiert javadoc die Dokumente nur für public Zeug, man kann aber einfach -private übergeben und er macht das auch für alle privaten Sachen. Sollten wir aber auf jeden Fall noch mal diskutieren, was wir da machen wollen. Die aktuelle gepushte build.xml baut (mit "ant doc" ) das auch mit private.

tikurion commented 9 years ago

Na ja, ich sage mal die privaten Methoden sind da wichtig wo eben nicht offensichtlich klar ist was sie tun. Schließlich geht es ja um die Quellen für die Bewertung. Wir stellen die Doku ja nicht für weitere Entwickler zur Verfügung die nur die API nutzen, sondern für Becker / Brix / David. Und mir persönlich hätten Kommentare hier oder da geholfen :D. Ich sage da kommentieren wo sinnvoll. Also auch private Methoden.