Comentarii Java: De ce și cum să le folosești?

În acest tutorial, veți afla despre comentariile Java, de ce le folosim și cum să folosiți comentariile în mod corect.

În programarea computerului, comentariile sunt o parte a programului care sunt complet ignorate de compilatoarele Java. Acestea sunt utilizate în principal pentru a ajuta programatorii să înțeleagă codul. De exemplu,

 // declare and initialize two variables int a =1; int b = 3; // print the output System.out.println("This is output"); 

Aici, am folosit următoarele comentarii,

  • declarați și inițializați două variabile
  • tipăriți ieșirea

Tipuri de comentarii în Java

În Java, există două tipuri de comentarii:

  • comentariu pe o singură linie
  • comentariu pe mai multe linii

Comentariu pe o singură linie

Un comentariu pe o singură linie începe și se termină în aceeași linie. Pentru a scrie un comentariu pe o singură linie, putem folosi //simbolul. De exemplu,

 // "Hello, World!" program example class Main ( public static void main(String() args) ( ( // prints "Hello, World!" System.out.println("Hello, World!"); ) ) 

Ieșire :

 Salut Lume! 

Aici, am folosit două comentarii pe o singură linie:

  • "Salut Lume!" exemplu de program
  • tipărește „Hello World!”

Compilatorul Java ignoră totul de //la sfârșitul liniei. Prin urmare, este cunoscut și sub numele de comentariu End of Line .

Comentariu pe mai multe linii

Când vrem să scriem comentarii în mai multe rânduri, putem folosi comentariul cu mai multe linii. Pentru a scrie comentarii pe mai multe linii, putem folosi simbolul / * …. * /. De exemplu,

 /* This is an example of multi-line comment. * The program prints "Hello, World!" to the standard output. */ class HelloWorld ( public static void main(String() args) ( ( System.out.println("Hello, World!"); ) ) 

Ieșire :

 Salut Lume! 

Aici am folosit comentariul pe mai multe linii:

 /* This is an example of multi-line comment. * The program prints "Hello, World!" to the standard output. */ 

Acest tip de comentariu este, de asemenea, cunoscut sub numele de Comentariu tradițional . În acest tip de comentariu, compilatorul Java ignoră totul de la /*până la */.

Utilizați comentariile în modul corect

Un lucru pe care ar trebui să îl considerați întotdeauna că comentariile nu ar trebui să înlocuiască un mod de a explica codul slab scris în limba engleză. Ar trebui să scrieți întotdeauna un cod bine structurat și explicabil. Și, apoi folosiți comentarii.

Unii cred că codul ar trebui să se autodescrie și comentariile ar trebui să fie rareori folosite. Cu toate acestea, în opinia mea personală, nu este nimic în neregulă cu utilizarea comentariilor. Putem folosi comentarii pentru a explica algoritmi complecși, regex sau scenarii în care trebuie să alegem o tehnică între diferite tehnici pentru a rezolva probleme.

Notă : În majoritatea cazurilor, folosiți întotdeauna comentarii pentru a explica „de ce ” mai degrabă decât „ cum ” și sunteți bine să mergeți.

Articole interesante...