CKTIS / Java
Komentarji in dokumentacija v Javi
Komentarji in dokumentacija v Javi: Java prepozna vrstične komentarje //, bločne /* ... */ in dokumentacijske /** ... */; javadoc razlaga oznake in iz doc comments ustvari dokumentacijo API.
Različica: Java SE 21 (JLS and Java SE API); examples verified on the repository Java runtime
Sintaksa
commentsJava prepozna vrstične komentarje //, bločne /* ... / in dokumentacijske /* ... */; javadoc razlaga oznake in iz doc comments ustvari dokumentacijo API.
Uporabi Javadoc za pogodbo javnega API z @param, @return in @throws ter {@code ...} za varen prikaz imen in odsekov kode.
Bločni komentarji se ne gnezdijo, zato komentiranje kode z */ komentar prezgodaj konča; zastarel komentar je slabši od natančnega imena.
Unicode escapes se obdelajo pred tokenizacijo: \u000a znotraj // lahko postane konec vrstice in povzroči prevajanje naslednjega besedila kot kode.
Komentarja // in /* ... */ ne spremenita izvajanja int value = 7; edina vrstica stdout 7 potrdi, da sta obravnavana kot komentarja.
Primeri
public class Main {
public static void main(String[] args) {
int value = 7; // this comment does not change the expression
/* A block comment can span lines. */
System.out.println(value);
}
}
Rezultat
7
Komentarja // in /* ... */ ne spremenita izvajanja int value = 7; edina vrstica stdout 7 potrdi, da sta obravnavana kot komentarja.