Wat zijn Java-opmerkingen en hoe maak je ze?
Er zijn drie verschillende soorten opmerkingen in Java. Je kunt opmerkingen gebruiken om je code te structureren en uit te leggen. Opmerkingen van één regel zijn bedoeld voor korte notities, terwijl blokopmerkingen geschikt zijn voor langere uitleg. Documentatieopmerkingen daarentegen zijn uitgebreid en bieden meerwaarde bovenop de broncode.
Wat zijn Java-opmerkingen?
Werken met broncode kan soms problemen opleveren, zelfs voor ervaren ontwikkelaars. Afhankelijk van het project en de omvang ervan kan de situatie snel onvoorspelbaar worden en kan de code verwarrend worden. Op zulke momenten wilt u misschien niet alleen aan uw code werken. Maar zelfs als u wilt dat anderen toegang hebben tot uw code, is het mogelijk dat zij deze niet intuïtief kunnen begrijpen.
Om misverstanden te voorkomen en code overzichtelijker te structureren, biedt Java gebruikers de mogelijkheid om opmerkingen te schrijven. U kunt opmerkingen in deze programmeertaal gebruiken om uw denkproces, berekeningen, methoden, klassen of structuren uit te leggen. Wanneer u of iemand anders later naar de code kijkt, maken de opmerkingen het werken met de code gemakkelijker.
Om ervoor te zorgen dat opmerkingen effectief zijn, is het belangrijk om ze zo kort mogelijk te houden. Tegelijkertijd moeten ze lezers voldoende informatie bieden. Bij het oplossen van problemen zijn goed geformuleerde opmerkingen essentieel.
Java-opmerkingen zijn beschikbaar in drie verschillende versies: opmerkingen op één regel, blokopmerkingen (opmerkingen op meerdere regels) en documentatieopmerkingen. Alle opmerkingen worden gemarkeerd, zodat ze niet in aanmerking worden genomen bij het compileren. In de volgende secties laten we u zien hoe u Java-opmerkingen kunt maken en wanneer u welke opmerking kunt gebruiken.
Welke soorten opmerkingen zijn er in Java?
Afhankelijk van het soort informatie dat u wilt schrijven, zijn er drie verschillende soorten opmerkingen beschikbaar in Java. Dit zijn:
Enkellijns opmerkingen
Dit is de eenvoudigste commentaaroptie. Dit type commentaar wordt gemaakt met twee opeenvolgende schuine strepen (//) en mag niet langer zijn dan één regel. Bij commentaar van één regel hoeft u geen eindpunt aan te geven, omdat dit automatisch wordt bereikt aan het einde van de regel. Dit type Java-commentaar is geschikt voor korte commentaren die een functie in enkele woorden uitleggen.
Meerregelige opmerkingen
Als uw uitleg wat langer moet zijn, kunt u meerregelige opmerkingen gebruiken. In theorie kunnen deze opmerkingen elke lengte hebben. Ze zijn geschikt voor het opnemen van alternatieve coderegels die niet worden gecompileerd of voor gedetailleerde uitleg. Meerregelige opmerkingen worden ingeleid met een schuine streep en een asterisk (/*). Aan het einde van de opmerking hoeft u alleen maar een asterisk gevolgd door een schuine streep te typen (*/). De tekst tussen de inleidende schuine streep en de afsluitende schuine streep wordt als opmerking behandeld en wordt niet meegenomen bij het compileren van de code.
Documentatie opmerkingen
Hoewel enkelregelige en meerregelige opmerkingen in theorie overal in de broncode kunnen worden ingevoegd, worden documentatieopmerkingen altijd direct voor de klassen of methoden geplaatst die ze beschrijven. Met behulp van tools worden deze opmerkingen uitgelezen en samengevat in HTML-documentatie. Ze worden voornamelijk gebruikt om metagegevens voor auteurs en bepaalde soorten parameters te creëren. Deze worden gemarkeerd met een @-symbool. Documentatieopmerkingen worden ingeleid met een schuine streep en twee sterretjes (/**) en eindigen met een sterretje en een schuine streep (*/).
Enkellijns opmerkingen
Om te begrijpen hoe Java-opmerkingen in de praktijk werken, bekijken we een paar eenvoudige voorbeelden. U kunt deze zelf uitproberen om de uitvoer te testen. Een opmerking van één regel begint met twee schuine strepen en kan op een aparte regel staan of achter een reeks instructies worden geplaatst. **. Zo ziet de opmerking eruit op een aparte regel:
// 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.");
}
}Als u het Java-commando System.out.println gebruikt, wordt alleen de zin ‘Dit is de tekst die aan het einde wordt weergegeven’ weergegeven. De twee opmerkingen verschijnen alleen in de broncode.
Je kunt de opmerking ook direct achter het commando plaatsen:
// 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.
}
}De plaatsing van de opmerking verandert niets aan de uitvoer.
Meerregelige opmerkingen
Als u een meerregelige opmerking in uw code wilt invoegen, kunt u deze voor of na de instructies in uw code plaatsen. Meerregelige opmerkingen worden altijd voorafgegaan door een schuine streep en een asterisk. Hier volgt een meerregelige opmerking vóór de code-instructies:
/* 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.");
}
}De uitvoer luidt: “Dit is de tekst die aan het einde wordt weergegeven.”
Hier volgt hoe u de opmerking onder de instructies kunt invoegen:
// 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. */
}
}De uitvoer moet hetzelfde zijn als in het vorige voorbeeld. De opmerking op één regel in de eerste regel van het codefragment wordt ook niet weergegeven. U kunt het sterretje en de schuine streep direct achter de opmerking plaatsen of een aparte regel gebruiken.
Documentatie opmerkingen
Documentatiecommentaar werkt op dezelfde manier als blokcommentaar, maar wordt voorafgegaan door een schuine streep en twee sterretjes. Hierdoor kunnen documentatietools het commentaar gebruiken om documentatie te maken. Indien nodig kunnen ze ook HTML-tags bevatten, zoals <h1>, <p> of <strong>.
Javadoc, een populaire tool die u kunt gebruiken om documentatiecommentaar voor te lezen, maakt ook gebruik van andere handige tags. Hier zijn enkele van de belangrijkste:
| Tag | Syntaxis | Functie |
|---|---|---|
| @auteur | @auteur naam-tekst | Voegt de auteur van de klasse toe |
| @code | {@code tekst} | Geeft alternatieve code weer, die niet automatisch wordt geïnterpreteerd |
| @deprecated | @deprecated verouderde tekst | Voegt een opmerking toe die het gebruik van een bepaalde interface afraadt |
| @param | @param parameter-naam-beschrijving | Wordt gebruikt om een specifieke parameter te markeren |
| @zie | @zie referentie | Kan worden gebruikt om naar andere referenties te verwijzen |