Kirjautuminen

Haku

Tehtävät

Keskustelu: Ohjelmointikysymykset: Java: Javadoc

jeepatijee [23.11.2008 16:49:30]

#

Onko javadoc:ssa yleensä tapana kommentoida attribuutit?

Jackal von ÖRF [23.11.2008 18:56:25]

#

Riippuu keneltä kysyy.

Oma kantani on, että ennemmin nimetään metodit ja muuttujat niin hyvin, ettei kommentteja tarvita. (Poikkeuksena julkinen API, jonka lähdekoodit eivät ole saatavilla - silloin ei ole paljon muita vaihtoehtoja kuin kirjoittaa javadocseja.) Nyrkkisääntönä, jos kommentti vastaa kysymykseen mitä tai miten, niin kommentin sijaan asia pitäisi ilmaista koodissa. Jos kommentti vastaa kysymykseen miksi, eikä sitä voi ilmaista riittävän hyvin koodissa, niin sitten on perusteltua kirjoittaa ytimekäs ja täydellinen kommentti.

http://butunclebob.com/ArticleS.TimOttinger.ApologizeIncode
http://tottinge.blogsome.com/meaningfulnames/

Vastaus

Aihe on jo aika vanha, joten et voi enää vastata siihen.

Tietoa sivustosta