Java komentāru izmantošana

Visas programmēšanas valodas atbalsta komentārus, kurus kompilators ignorē

Kšištofs Zmijs/E+/Getty Images

Java komentāri ir piezīmes Java koda failā, kuras kompilators un izpildlaika programma ignorē. Tie tiek izmantoti koda anotēšanai, lai precizētu tā dizainu un mērķi. Java failam varat pievienot neierobežotu skaitu komentāru, taču ir daži “labākās prakses piemēri”, kas jāievēro, izmantojot komentārus.

Parasti koda komentāri ir “ieviešanas” komentāri, kas izskaidro avota kods , piemēram, klašu, saskarņu, metožu un lauku apraksti. Parasti tās ir dažas rindiņas, kas rakstītas virs Java koda vai tam blakus, lai precizētu, ko tas dara.

Cits Java komentāru veids ir Javadoc komentārs. Javadoc komentāru sintakse nedaudz atšķiras no ieviešanas komentāriem, un tos izmanto programma javadoc.exe, lai ģenerētu Java HTML dokumentāciju.

Kāpēc izmantot Java komentārus?

Laba prakse ir ieradums ievietot Java komentārus avota kodā, lai uzlabotu tā lasāmību un skaidrību sev un citiem programmētājiem. Ne vienmēr ir uzreiz skaidrs, kāda Java koda sadaļa darbojas. Dažas paskaidrojošas rindiņas var krasi samazināt laiku, kas nepieciešams koda izpratnei.

Vai tie ietekmē programmas darbību?

Ieviešanas komentāri Java kods ir tikai cilvēku lasīšanai. Java kompilatoriem ir vienalga par tiem un kad programmas sastādīšana , viņi vienkārši izlaiž tos pāri. Jūsu kompilētās programmas lielumu un efektivitāti neietekmēs komentāru skaits jūsu pirmkodā.

Ieviešanas komentāri

Ieviešanas komentāri ir pieejami divos dažādos formātos.

Rindas komentāri:Lai komentētu vienu rindiņu, ierakstiet “//” un sekojiet divām slīpsvītrām ar komentāru. Piemēram: |_+_|Kad kompilators saskaras ar divām slīpsvītrām, tas zina, ka viss, kas atrodas pa labi no tiem, ir jāuzskata par komentāru. Tas ir noderīgi, atkļūdojot koda daļu. Vienkārši pievienojiet komentāru no koda rindiņas, kuru veicat atkļūdošanu, un kompilators to neredzēs:
• |_+_|Varat arī izmantot divas slīpsvītras, lai pievienotu rindiņas beigu komentāru:
• |_+_|
Bloķēt komentārus:Lai sāktu bloķēt komentāru, ierakstiet “/*”. Viss, kas atrodas starp slīpsvītru un zvaigznīti, pat ja tas atrodas citā rindiņā, tiek uzskatīts par komentāru, līdz rakstzīmes “*/” beidz komentāru. Piemēram: |_+_|

Javadoc komentāri

Izmantojiet īpašus Javadoc komentārus, lai dokumentētu savu Java API. Javadoc ir rīks, kas iekļauts JDK, kas ģenerē HTML dokumentāciju no komentāriem avota kodā.

Ienāk Javadoc komentārs

|_+_| avota faili ir iekļauti sākuma un beigu sintaksē, piemēram: |_+_| un |_+_|. Katra komentāra priekšā ir |_+_|

Javadoc ietver dažādus tagus, kas kontrolē dokumentācijas ģenerēšanu. Piemēram,

|_+_|

Programmā Javadoc ir pieejami daudzi citi tagi, un tas atbalsta arī HTML tagus, lai palīdzētu kontrolēt izvadi. Plašāku informāciju skatiet Java dokumentācijā.

Padomi komentāru lietošanai

Nevajag komentēt.Katra programmas rindiņa nav jāpaskaidro. Ja jūsu programma darbojas loģiski un nekas negaidīts nenotiek, nejūtiet vajadzību pievienot komentāru.Atzīmējiet savus komentārus.Ja komentētā koda rindiņa ir atkāpe, pārliecinieties, vai komentārs atbilst atkāpei.Saglabājiet komentārus atbilstošus.Daži programmētāji lieliski pārvalda kodu, taču kaut kādu iemeslu dēļ aizmirst atjaunināt komentārus. Ja komentārs vairs nav spēkā, mainiet to vai noņemiet to.Neievietojiet bloķēt komentārus.Šādas darbības rezultātā radīsies kompilatora kļūda: |_+_|