Latest web development tutorials

Java Dokumentasi Komentar

Java anotasi hanya tiga macam cara. Dua yang pertama adalah // dan / * * /, dan ketiga disebut legenda komentar yang diawali dengan / **, berakhir dengan * /.

Deskripsi Komentar memungkinkan Anda untuk menanamkan informasi tentang program dalam program ini. Anda dapat menggunakan alat javadoc untuk menghasilkan informasi dan output ke file HTML.

Deskripsi Komentar, Anda merekam informasi lebih lanjut mengenai program anda.

tag javadoc

alat javadoc mengakui tag berikut:

label deskripsi contoh
@author Mengidentifikasi kelas penulis deskripsi @author
@deprecated Dinamakan anggota kelas atau kedaluwarsa deskripsi @deprecated
{@docRoot} Jalur yang ditetapkan dalam dokumen direktori root saat Direktori Jalur
@exception Menandai pengecualian kelas dilemparkan @exception pengecualian-nama penjelasan
{@inheritDoc} Langsung dari orang tua kelas mewarisi komentar Mewarisi komentar dari surperclass langsung.
{@link} Memasukkan link ke topik lain {Teks Nama @link}
{@linkplain} Menyisipkan link ke topik lain, tetapi link ditampilkan dalam font teks biasa Menyisipkan link in-line ke topik lain.
@param Deskripsi dari parameter metode @param parameter-nama penjelasan
@return Kembali Jenis Deskripsi penjelasan @return
@see Menentukan link ke topik lain anchor @see
@serial Deskripsi dari urutan properti deskripsi @serial
@serialData Deskripsi Metode ditulis oleh writeObject () dan writeExternal () Data deskripsi @serialData
@serialField Penjelasan dari komponen ObjectStreamField @serialField deskripsi nama jenis
@since Ketika memperkenalkan penanda spesifik perubahan rilis @since
@throws Dan @exception label yang sama. The @throws tag memiliki arti yang sama dengan tag @exception.
{@value} nilai tampilan dari konstan, konstan harus menjadi properti statis. Menampilkan nilai konstan, yang harus menjadi bidang statis.
@version Versi dari kelas tertentu @version Info

dokumentasi Komentar

Setelah start / **, baris pertama atau garis adalah deskripsi utama kelas, variabel dan metode.

Setelah itu, Anda dapat mencakup satu atau lebih dari apa yang macam dari @ tag. @ Setiap tag harus berada di baris baru, atau mulai dari awal garis diikuti dengan tanda bintang (*).

Sebuah pluralitas dari jenis yang sama dari label harus ditempatkan dalam sebuah kelompok. Misalnya, jika Anda memiliki tiga tag @see, mereka dapat disatukan satu per satu.

Berikut ini adalah deskripsi dari contoh komentar kelas: 

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

Apa output yang javadoc

tool javadoc kode sumber program Java Anda sebagai input, output beberapa file HTML yang berisi penjelasan program anda.

Setiap jenis informasi akan sendirian dalam file HTML. Output javadoc juga dapat diwariskan pohon dan indeks.

Karena berbeda javadoc pelaksanaan pekerjaan mungkin berbeda, Anda perlu memeriksa versi sistem pengembangan Java dan rincian lainnya, pilih versi yang sesuai dari Javadoc.

contoh

Berikut ini adalah komentar yang menjelaskan penggunaan contoh sederhana. Perhatikan bahwa proyek sebelumnya setiap penjelasan dalam deskripsi.

Setelah pengobatan javadoc, catatan kelas SquareNum akan ditemukan di SquareNum.html. 

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);
   }
}

Sebagai berikut, menggunakan alat javadoc untuk memproses file SquareNum.java: 

$ javadoc SquareNum.java
Loading source file SquareNum.java...
Constructing Javadoc information...
Standard Doclet version 1.5.0_13
Building tree for all the packages and classes...
Generating SquareNum.html...
SquareNum.java:39: warning - @return tag cannot be used\
                      in method with void return type.
Generating package-frame.html...
Generating package-summary.html...
Generating package-tree.html...
Generating constant-values.html...
Building index for all the packages and classes...
Generating overview-tree.html...
Generating index-all.html...
Generating deprecated-list.html...
Building index for all classes...
Generating allclasses-frame.html...
Generating allclasses-noframe.html...
Generating index.html...
Generating help-doc.html...
Generating stylesheet.css...
1 warning
$