Mik azok a Java megjegyzések és hogyan lehet őket létrehozni?

A Java nyelvben háromféle kommentár létezik. A kommentárok segítségével strukturálhatja és magyarázhatja a kódját. Az egy soros kommentárok rövid megjegyzésekhez, a blokkkommentárok pedig hosszabb magyarázatokhoz alkalmasak. A dokumentációs kommentárok viszont kiterjedtek és a forráskódon túlmutató értéket nyújtanak.

Mik azok a Java megjegyzések?

A forráskóddal való munka néha problémákat okozhat, még a tapasztalt fejlesztők számára is. A projekttől és annak terjedelmétől függően a dolgok gyorsan kiszámíthatatlanná válhatnak, és a kód zavarossá válhat. Ilyen pillanatokban előfordulhat, hogy nem szeretne egyedül dolgozni a kódján. De még ha szeretné is, hogy mások hozzáférjenek a kódjához, lehet, hogy ők nem tudják intuitív módon megérteni azt.

A félreértések elkerülése és a kód egyértelműbb felépítése érdekében a Java lehetővé teszi a felhasználók számára, hogy megjegyzéseket írjanak. Ebben a programozási nyelvben megjegyzéseket használhat a gondolkodási folyamat, a számítások, a módszerek, az osztályok vagy a struktúrák magyarázatára. Amikor Ön vagy mások később megnézik a kódot, a megjegyzések megkönnyítik a kóddal való munkát.

A megjegyzések hatékonyságának biztosítása érdekében fontos, hogy azok a lehető legrövidebbek legyenek. Ugyanakkor elegendő információt kell nyújtaniuk az olvasóknak. A hibaelhárítás során elengedhetetlenek a jól megfogalmazott megjegyzések.

A Java megjegyzések három különböző változatban állnak rendelkezésre: egysoros megjegyzések, blokk megjegyzések (többsoros megjegyzések) és dokumentációs megjegyzések. Minden megjegyzés ki van jelölve, így a fordítás során nem veszik őket figyelembe. A következő szakaszokban bemutatjuk, hogyan lehet Java megjegyzéseket létrehozni, és mikor kell az egyes típusokat használni.

Milyen típusú megjegyzések vannak a Java-ban?

Az írásra szánt információ típusától függően háromféle megjegyzés létezik a Java nyelvben. Ezek a következők:

Egy soros megjegyzések

Ez a legegyszerűbb megjegyzés opció. Ez a típusú megjegyzés két egymást követő perjel (//) segítségével hozható létre, és nem lehet hosszabb egy sornál. Az egy soros megjegyzéseknél nem kell megjelölni a végpontot, mivel ez automatikusan a sor végén érhető el. Ez a típusú Java megjegyzés rövid megjegyzésekhez alkalmas, amelyek néhány szóval magyarázzák a funkciót.

Többsoros megjegyzések

Ha magyarázataidnak kicsit hosszabbnak kell lenniük, többsoros megjegyzéseket használhatsz. Elméletileg ezek bármilyen hosszúságúak lehetnek. Alkalmasak olyan alternatív kódsorok beillesztésére, amelyek nem kerülnek be a fordításba, vagy részletes magyarázatokra. A többsoros megjegyzéseket perjel és csillag jelöli (/*). A megjegyzés végére érve csak egy csillagot és egy perjelet kell beírnia (*/). A bevezető perjel és a záró perjel közötti szöveg megjegyzésként kezelendő, és a kód fordításakor nem veszik figyelembe.

Dokumentációs megjegyzések

Míg az egy- és többsoros megjegyzéseket elméletileg a forráskód bármely pontjára be lehet illeszteni, a dokumentációs megjegyzéseket mindig közvetlenül az általuk leírt osztályok vagy módszerek elé kell elhelyezni. Ezeket a megjegyzéseket eszközök segítségével kiolvassák és HTML-dokumentációban összefoglalják. Elsősorban szerzők és bizonyos típusú paraméterek metaadatainak létrehozására használják őket. Ezeket @ szimbólummal jelölik. A dokumentációs megjegyzéseket perjel és két csillag (/**) jelöli, és csillaggal és perjellel (*/) végződnek.

Egy soros megjegyzések

Ahhoz, hogy megértsük, hogyan működnek a Java megjegyzések a gyakorlatban, nézzünk meg néhány egyszerű példát. Ezeket kipróbálhatja saját maga is, hogy tesztelje az eredményt. Az egy soros megjegyzés két perjeljel kezdődik, és lehet önálló sorban vagy egy utasításcsoport után elhelyezve. **. Így néz ki a megjegyzés önálló sorban:

// Example of a single-line comment
class Main {
	public static void main(String[] args) {
	// Here is the comment
	System.out.println("This is the text that will be output at the end.");
	}
}

Ha a Java System.out.println parancsot használja, csak a „Ez a szöveg jelenik meg a végén” mondat jelenik meg. A két megjegyzés csak a forráskódban jelenik meg.

Alternatív megoldásként a megjegyzést közvetlenül a parancs után is elhelyezheti:

// Example of a single-line comment
class Main {
public static void main(String[] args) {
System.out.println("This is the text that is output at the end."); // This is the comment.
	}
}

A megjegyzés elhelyezése nem változtatja meg a kimenetet.

Többsoros megjegyzések

Ha többsoros megjegyzést szeretne beilleszteni a kódjába, azt a kód utasításai elé vagy után beillesztheti. A többsoros megjegyzéseket mindig perjel és csillag jelöli. Íme egy többsoros megjegyzés a kód utasításai előtt:

/* In this example there is a multi-line comment.
It starts after the asterisk.
The actual instructions for the computer are under the comment.
This is the last line of this Java comment.
*/
class Main {
public static void main(String[] args) {
System.out.println("This is the text that will be output at the end.");
	}
}

A kimenet a következő: „Ez az a szöveg, amely a végén megjelenik.”

Így illessze be a megjegyzést az utasítások alá:

// Example of a multi-line comment below the instructions
class Main {
public static void main(String[] args) {
System.out.println("This is the text that will be output at the end.");
/* In this example there is a multi-line comment.
It starts after the asterisk.
The actual instructions for the computer are above the comment.
This is the last line of this Java comment. */
	}
}

A kimenetnek meg kell egyeznie az előző példában láthatóval. A kódrészlet első sorában található egysoros megjegyzés sem kerül kimenetre. A csillagot és a perjelet közvetlenül a megjegyzés után helyezheti el, vagy külön sorban is használhatja.

Dokumentációs megjegyzések

A dokumentációs megjegyzések hasonlóan működnek, mint a blokk megjegyzések, de egy perjel és két csillag jelöli őket. Ez lehetővé teszi a dokumentációs eszközök számára, hogy a megjegyzéseket felhasználva dokumentációt hozzanak létre. Szükség esetén HTML-címkéket is tartalmazhatnak, például <h1>, <p> vagy <strong>.

A Javadoc, egy népszerű eszköz, amellyel dokumentációs megjegyzéseket olvashatunk, más hasznos címkéket is használ. Íme a legfontosabbak közül néhány: