Jak napisać komentarz Javadoc?

„Komentarze odgrywają bardzo istotną rolę w życiu, ja.mi., aby zmusić ich do ulepszenia ich stylu życia i wszystkiego, co jest związane. Istnieją głównie dwa rodzaje komentarzy, i.mi., Komentarze jednoliniowe i komentarze wieloletnie. Ale jest inny rodzaj komentarza, którego zwykle się nie uczymy, ja.mi., Komentarze Javadoc. Komentarze Javadoc są zwykle znane wśród programistów Java i mogą być generowane przez JDK programu i nie musisz tworzyć swoich komentarzy. Program o nazwie Javadoc jest dołączony do JDK i jest wykorzystywany do wygenerowania opisu kodu Java HTML za pośrednictwem źródła języka Java, który wymaga dokumentacji w określony sposób. W tym samouczku przyjrzysz się komentarzom Javadoc w programowaniu Java za pomocą narzędzia Java w systemie Windows."

Składnia

Po pierwsze, musimy zobaczyć podstawową składnię komentarzy Javadoc w Javie. Używamy więc prostego edytora, aby umieścić w nim kilka komentarzy Javadoc i wyświetlać jego prezentację poniżej na załączonym obrazie. Autogenerowany komentarz dokumentu Java zaczyna się od jakiejś specjalnej postaci, takich jak gwiazdka, a pierwsza linia całego komentarza może być zielony kolor. Możesz zobaczyć przedstawienie komentarza do dokumentu Java, który ma wiele znaków gwiazdkowych na początku każdego komentarza od początku do końca.

Na początku komentarz do dokumentu Java zaczyna się od postaci „/”, a następnie dwóch znaków gwiazdkowych. Jednocześnie wszystkie pozostałe linie zawierają jeden znak gwiazdkowy na swoim początku. Pod koniec komentarza do dokumentu Java zakończyliśmy go postacią „/”. Pomiędzy tym ilustracją komentarza dokumentu Java zobaczysz wiersz komentarzy „7”, w którym zdefiniowaliśmy nazwę autora za pomocą postaci „@”, aby zdefiniować zmienną „autor” o imieniu autora komentarza, i.mi., Saeed Raza. Informacje o meta-data komentarzy do dokumentów Java muszą być zawsze napisane z znakiem „@”.

Utwórz automatyczny komentarz do dokumentu Java w Eclipse IDE

W tym przykładzie wykorzystuje środowisko programistyczne Eclipse Ide Java do tworzenia automatycznych komentarzy w projekcie Java. W tym celu musisz mieć zamontowany i skonfigurowany zaćmienie IDE. Uruchom więc Eclipse IDE i spróbuj stworzyć nowy projekt o nazwie „Java”. Poprosi Cię o nazwanie bieżącego pakietu projektu. Nazwaliśmy to również „Java”. Następnie musisz utworzyć nowy plik Java lub utworzyć nową klasę w ramach tego samego projektu Java. W tym celu prawe kryte nazwę pakietu z lewego rogu paska Explorer Project Explorer Eclipse IDE przejdź do opcji „NOWA” i naciśnij słowo kluczowe „klasowe” z rozszerzonych opcji. Wygeneruje to nowe okno na ekranie z tytułem „Nowa klasa Java”, jak pokazano na poniższym obrazku.

Teraz musisz wstawić nazwę klasy, która ma zostać utworzona w polu tekstowym przed etykietą „Nazwa”. Większość rzeczy pozostanie niezmienionych, ponieważ zostały one wybrane automatycznie za każdym razem, gdy spróbujesz utworzyć nową klasę. Wystarczy wyczyścić koniec metody, którą chcesz utworzyć dla swojego kodu Java. Dlatego sprawdziliśmy pierwsze pole wyboru, aby utworzyć funkcję sterownika Main () w tej klasie. Wreszcie znajdziesz możliwość dodania domyślnych komentarzy w programie Java do utworzenia. Musisz tylko zaznaczyć pole wyboru o nazwie „Generuj komentarze”. To będzie fenomenalny krok w tworzeniu kodu Java. Naciśnijmy przycisk „Zakończ” po podaniu wszystkich niezbędnych informacji.

Program Java Phise-Below został utworzony w narzędziu Eclipse IDE wraz z automatycznymi komentarzami. Widać, że komentarze do dokumentu Java zaczęły się od postaci Asterisk. Zapewnia również informacje o meta-data dotyczące projektu, tj.mi., Autor. Oprócz tego pokazuje również, że automatyczne komentarze przedstawiają również funkcję główną odcinka. Chodzi o automatyczne generowanie komentarzy Javadoc w Eclipse IDE.

Przykład 01: Komentarze Javadoc

Teraz możesz tworzyć własne komentarze dokumentów Java podczas kodowania. Oto kolejna ilustracja, aby to zrobić. Ilekroć używasz funkcji sterownika Main () w kodzie, i.mi., Powinieneś był używać go w każdym programie, zawsze powinieneś tworzyć jego komentarz u góry pliku lub, w ramach tej funkcji, zacznij jak „// todo automatycznie generowane” odcinek metody ”. Ten komentarz wyjaśnia, że ​​metoda main () została wygenerowana automatycznie, i.mi., Nie musisz tego pisać.

Następnie dodaliśmy krótki komentarz Javadoc, który opracowuje korzystanie z tego programu wraz z informacjami o meta-data, i.mi., autor, wersja i data, w której została utworzona. Przed instrukcją „println” istnieje pojedynczy wiersz komentarzy do wyjaśnienia celu użycia funkcji println (). To wszystko dla tego przykładu.

Wykonanie programów z komentarzami nie wpływa na dane wyjściowe jak poniżej.

Przykład 01: Komentarze jednoladowe i wielopoziomowe

Po przejrzeniu komentarzy Javadoc w Eclipse IDE, zacznijmy przyjrzeć się innym przykładowi Java wykorzystującego komentarze jednokierunkowe i wielokrotnie, i.mi., określony przez użytkownika. Teraz wygenerowaliśmy nową klasę „test” i zawarliśmy w niej metodę main (). Ta metoda zawiera instrukcję funkcji println (), aby coś wyświetlić. Wykorzystaliśmy komentarz jednoliniowy z nazwą klasy, zaczynając od postaci „//”, i.mi., wyjaśnia, że ​​jest to inicjalizacja klasowa. W linii definicji funkcji Main () dodano komentarz wieloletnich, zaczynając od znaków „/*” i kończących się znakami „*/”.

Wniosek

Ten artykuł pomaga zrozumieć znaczenie i witalność komentarzy używanych w życiu codziennym i programowaniu. Omawia, w jaki sposób te komentarze mogą ci pomóc na wiele sposobów. Po pierwsze, omówiliśmy, jakie są komentarze Javadoc i bardzo krótko wyjaśniliśmy ich składnię. Następnie wyjaśniliśmy całą metodę w Eclipse IDE, aby wygenerować automatyczne komentarze Javadoc w ciągu kilku sekund i za pomocą kilku kliknięć na GUI.