Java Dokumentacja Komentarze

Java adnotacje tylko trzy rodzaje sposobów. Pierwsze dwa są // a / * * /, a trzeci jest nazywany komentarz legenda, że ​​zaczyna się od / **, koniec z * /.

Opis Komentarz pozwala na umieszczanie informacji o programie w programie. Można użyć narzędzia javadoc do generowania informacji i wyjście do plików HTML.

Opis Komentarz, nagrać więcej informacji na temat programu.

---

tag javadoc

Narzędzie javadoc rozpoznaje następujące znaczniki:

etykieta	opis	przykład
@author	Określa klasę autorów	@author opis
@deprecated	Nazwany członkiem klasy lub wygasł	@deprecated opis
{@docRoot}	Ścieżka określona w bieżącym dokumencie katalogu	Ścieżka katalogu
@exception	Oznaczyć klasę wyjątków zgłaszanych	@exception exception-name Objaśnienie
{@inheritDoc}	Bezpośrednio od rodzica klasa dziedziczy komentarz	Dziedziczy komentarz z bezpośrednim surperclass.
{@link}	Wstawianie łącza do innego tematu	{@link Nazwa tekst}
{@linkplain}	Wstaw link do innego tematu, ale link jest wyświetlany czcionką tekstowym	Wstawia ogniwo-line do innego tematu.
@param	Opis parametru metody	@param parametr nazwa wyjaśnienie
@return	Powrót Typ Opis	@return wyjaśnienie
@see	Określa link do innego tematu	@see kotwica
@serial	Opis sekwencji własności	@serial opis
@serialData	Opis Metoda napisany przez writeObject () i writeExternal () dane	opis @serialData
@serialField	Opis składników ObjectStreamField	@serialField Opis Typ Nazwa
@since	Przy wprowadzaniu konkretnego markera zmianę	uwalnianie @since
@throws	I @exception samej etykiecie.	Znacznik @throws ma takie samo znaczenie jak znacznik @exception.
{@value}	Wyświetlanie wartości stałej, stała musi być obiektem statycznym.	Wyświetla wartość stałą, która musi być polem statycznym.
@version	Wersja określonej klasy	@version informacji

---

Dokumentacja Komentarze

Po rozpoczęciu / **, pierwsza linia lub linie jest głównym opis klas, zmiennych i metod.

Następnie, można wykonać jedną lub więcej z jakiego rodzaju @ znacznika. @ Każdy znacznik musi być w nowej linii, lub rozpocząć na początku linii, a następnie oznaczone gwiazdką (*).

Wiele z tego samego rodzaju etykieta powinna być umieszczona w grupie. Na przykład, jeśli masz trzy @see tagów, można je złożyć jeden po drugim.

Poniżej znajduje się opis przykładu komentarzu klasy:

/*** This class draws a bar chart.
* @author Zara Ali
* @version 1.2
*/

---

Jakie wyjście javadoc

Narzędzie javadoc kodu źródłowego programu Java jako wejście, wyjście jakiś plik HTML zawierający adnotacje programu.

Każdy rodzaj informacji będzie sam w pliku HTML. Wyjście javadoc mogą być również dziedziczone drzewa i indeksów.

Ze względu na różne prace wdrożeniowe javadoc może być inna, trzeba sprawdzić wersję systemu rozwoju Java i inne szczegóły, należy wybrać odpowiednią wersję Javadoc.

Przykłady

Poniżej znajduje się komentarz, który wyjaśnia zastosowanie prostego przykładu. Należy zauważyć, że w poprzednim projekcie każdej adnotacji w jego opisie.

Po leczeniu javadoc, klasa notatki SquareNum będzie można znaleźć w SquareNum.

import java.io.*;
 
/**
* This class demonstrates documentation comments.
* @author Ayan Amhed
* @version 1.2
*/
public class SquareNum {
   /**
   * This method returns the square of num.
   * This is a multiline description. You can use
   * as many lines as you like.
   * @param num The value to be squared.
   * @return num squared.
   */
   public double square(double num) {
      return num * num;
   }
   /**
   * This method inputs a number from the user.
   * @return The value input as a double.
   * @exception IOException On input error.
   * @see IOException
   */
   public double getNumber() throws IOException {
      InputStreamReader isr = new InputStreamReader(System.in);
      BufferedReader inData = new BufferedReader(isr);
      String str;
      str = inData.readLine();
      return (new Double(str)).doubleValue();
   }
   /**
   * This method demonstrates square().
   * @param args Unused.
   * @return Nothing.
   * @exception IOException On input error.
   * @see IOException
   */
   public static void main(String args[]) throws IOException
   {
      SquareNum ob = new SquareNum();
      double val;
      System.out.println("Enter value to be squared: ");
      val = ob.getNumber();
      val = ob.square(val);
      System.out.println("Squared value is " + val);
   }
}

Jak wynika za pomocą narzędzia javadoc przetwarzać SquareNum.java pliku:

$ javadoc SquareNum.java
Loading source file SquareNum.javapl.
Constructing Javadoc informationpl.
Standard Doclet version 1.5.0_13
Building tree for all the packages and classespl.
Generating SquareNumpl.
SquareNum.java:39: warning - @return tag cannot be used\
                      in method with void return type.
Generating package-framepl.
Generating package-summarypl.
Generating package-treepl.
Generating constant-valuespl.
Building index for all the packages and classespl.
Generating overview-treepl.
Generating index-allpl.
Generating deprecated-listpl.
Building index for all classespl.
Generating allclasses-framepl.
Generating allclasses-noframepl.
Generating indexpl.
Generating help-docpl.
Generating stylesheet.csspl.
1 warning
$