Miten toi kommentointi javassa on viimesenpäälle oikein?
Toimiiko se jollain näistä "oikein":
// tekstiä
tai
/* tekstiä */
tai
/** tekstiä */
tai
/**
* tekstiä
*/
Toimiiko se jollain näistä "oikein":
// tekstiä
tai
/* tekstiä */
tai
/** tekstiä */
tai
/**
* tekstiä
*/
Vastaukset 3
Vanhimmat
yhden rivin kommentti näin
// tämä on kommentti
usean rivin kommentti näin
/* jee tämä on sitten ***Eee*ER*
monella rivillä oleva
*************kommentti joka päättyy seuraavaan merkkiin
*/
Toi "/** ... */" tyylinen kommentti on dokumentointi kommentti ja liittyy javadoc:iin. Sitä ei ehkei kannata käyttää jollei tiedä miten se vaikuttaa javadoc:n generoimaan dokumentti tiedostoon.
Jotta kommentti erottuisi muusta koodista, aloitetaan se isolla kirjaimella ja päätetään isoon välimerkkiin! Ei vaikuta koodiin mutta noudattaa hyvää koodausta.
Yhden rivin kommentti:
//Kommentointia.
Yhden, kahden rivin kommentti:
//Kommentointia
//Kommentointia.
Useamman rivin kommentti:
/*
*Kommentointia
*Kommentointia.
*
*/