Spisu treści:

Jak napisać dokument Javadoc?
Jak napisać dokument Javadoc?

Wideo: Jak napisać dokument Javadoc?

Wideo: Jak napisać dokument Javadoc?
Wideo: Создание аннотации в java [Java Annotations | Reflection api] 2024, Listopad
Anonim

Standard kodowania Javadoc

  1. Napisz Javadoc do odczytania jako kod źródłowy.
  2. Publiczne i chronione.
  3. Użyj standardowego stylu dla Javadoc komentarz.
  4. Używaj prostych tagów HTML, a nie prawidłowego XHTML.
  5. Użyj jednego

    tag między akapitami.

  6. Użyj jednego
  7. znacznik dla pozycji na liście.
  8. Zdefiniuj mocne pierwsze zdanie.

W związku z tym, jak zrobić dokument Javadoc?

podać wersję klasy, interfejsu lub wyliczenia. Wybierz „Generuj JavaDoc ” z menu Projekt i pojawi się kreator. Określ lokalizację dla JavaDoc na twoim komputerze, domyślnie będzie na dysku C. Wybierz projekt, a następnie pakiety, dla których chcesz utworzyć JavaDoc plik.

Następnie pojawia się pytanie, czym są javadocy i kiedy należy ich używać? Javadoc to narzędzie, które jest dostarczane z JDK i jest używany do generowania dokumentacji kodu Java w formacie HTML z kodu źródłowego Java, co wymaga dokumentacji w predefiniowanym formacie. */ to wielowierszowe komentarze Java. Podobnie wiersz poprzedzający // to jednowierszowy komentarz Java.

Biorąc to pod uwagę, czym jest polecenie Javadoc?

javadoc jest Komenda -line narzędzie do wyodrębniania specjalnych komentarzy (zwanych komentarzami doc) z plików źródłowych java i generowania łatwego w użyciu drzewa plików HTML, które je zawiera. Komentarze mogą zawierać standardowe znaczniki HTML i javadoc @tagi. Specyfikacja Java API jest przykładem tego, co javadoc produkuje.

Jak otworzyć plik Javadoc?

Aby zlokalizować Javadoc , przejdź do folderu użytkownika (w systemie Windows 7 jest to C:Users*Username*), a następnie przejdź do sunspotfrcsdk/doc/ javadoc . Kliknij dwukrotnie indeks. plik html do otwarty w domyślnej przeglądarce internetowej.

Zalecana: