Како се користе коментари у Јава Цоде

Јава коментари су белешке у датотеци Јава кодова које компајлер и рунтиме енгине игноришу. Користе се за обележавање кода ради разјашњења његовог дизајна и сврхе. Можете да додате неограничен број коментара у Јава датотеку, али постоје неке „најбоље праксе“ које треба следити када користите коментаре.

Опћенито, коментари кода су коментари "имплементације" који објашњавају изворни код, као што су описи класа, интерфејса, метода и поља. То су обично пар редака написаних изнад или поред Јава кода како би се разјаснило шта се ради.

Друга врста Јава коментара је Јавадоц коментар. Јавадоц коментари се по синтакси разликују од коментара на имплементацију и програм их користи јавадоц.еке за генерисање Јава ХТМЛ документације.

Добра пракса је да се навикнете стављати Јава коментаре у ваш изворни код како бисте побољшали њену читљивост и јасноћу за себе и друге програмере. Није увек одмах јасно који одељак Јава кода ради. Неколико објашњења могу драстично смањити количину времена потребно за разумевање кода.

Коментари за имплементацију у Јава код постоје само људи за читање. Јава компајлере није брига за њих и када састављање програма, само прескачу преко њих. Величина и ефикасност компајлираног програма неће утицати на број коментара у вашем изворном коду.

Коментари за имплементацију долазе у два различита формата:

• Коментари на линији: За коментар у једном ретку откуцајте "//" и следите две косине напред са својим коментаром. На пример:

   // ово је коментар у једној линији
  инт погодити број = (инт) (Матх.рандом () * 10); 

  Када преводилац наиђе на две предње црте, он зна да све с десне стране треба сматрати коментаром. Ово је корисно код уклањања погрешака дела кода. Само додајте коментар из линије кода коју отклањате и компајлер неће видети:

  •  // ово је коментар у једној линији
    // инт погодити број = (инт) (Матх.рандом () * 10); 

    Такође можете да користите две предње црте за завршетак коментара на линији:

  •  // ово је коментар у једној линији
    инт погодити број = (инт) (Матх.рандом () * 10); // Крај ретка коментара 

• Блокирај коментаре: Да бисте започели коментар на блоку, откуцајте "/ *". Све између косог нагиба и звездице, чак и ако је на другој линији, третира се као коментар све док ликови „* /“ не заврше коментар. На пример:

   / * ово 
  је 
  а
  блокирати
  коментар
  */
  / * тако је и ово * /
  

Користите посебне Јавадоц коментаре за документовање Јава АПИ-ја. Јавадоц је алат укључен у ЈДК који генерише ХТМЛ документацију из коментара у изворном коду.

Јавадоц коментар

.јава

/**

*/

*

Ставите ове коментаре директно изнад методе, класе, конструктора или било којег другог Јава елемента који желите да документујете. На пример:

// миЦласс.јава
/**
* Учините ово сажетком реченице која описује вашу класу.
* Ево још једног ретка.
*/
јавникласа мој разред
{
...
}

Јавадоц садржи разне тагове који контролишу генерирање документације. На пример, тхе

@парам

 / ** главни метод
* @парам аргс Стринг []
*/​
јавнистатичкипразнина главни (Стринг [] аргс)
​{
Систем.оут.принтлн ("Поздрав свет!");
}

Много других ознака је доступно у Јавадоцу, а такође подржава ХТМЛ ознаке за помоћ у контроли резултата. Погледајте своју Јава документацију за више детаља.

• Не коментирајте. Свака линија вашег програма није потребна за објашњење. Ако ваш програм тече логично и не догоди се ништа неочекивано, немојте осећати потребу да додате коментар.
• Унесите своје коментаре. Ако је линија кода коју коментирате разведена, провјерите да ли се коментар подудара са увлачењем.
• Држите коментаре релевантним. Неки програмери су изврсни у модификовању кода, али из неког разлога забораве да ажурирају коментаре. Ако коментар више не важи, модификујте или уклоните га.
• Не гнезди блок коментаре. Следеће ће резултирати грешком преводиоца:

   / * ово 
  је
  / * Овај блок коментар завршава први коментар * /
  а
  блокирати
  коментар
  */