Dodatek B Javadoc

Programy napisane w języku Java mogą zawierać trzy rodzaje komentarzy:

Komentarze na końcu wierszy

Zaczynają się one znakami // i zwykle zawierają krótkie frazy wyjaśniające określone wiersze kodu.

Komentarze wielowierszowe

Zaczynają się znakami /*, kończą znakami */ i przeważnie są używane do podawania informacji o prawach autorskich.

Komentarze dokumentujące

Zaczynają się znakami /**, kończą znakami */ i opisują działanie każdej klasy i metody.

Komentarze na końcu wierszy i komentarze wielowierszowe pisze się przede wszystkim dla samego siebie. Uławiają Ci one pamiętanie szczegółów dotyczących Twojego kodu źródłowego. Komentarze dokumentujące z kolei są pisane dla innych osób. Wyjaśniają one, jak należy korzystać z Twoich ...

Get Myśl w języku Java! now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.