Komen dokumentasi Java
Java hanya mempunyai tiga kaedah anotasi. Dua yang pertama ialah // dan /* */, dan jenis ketiga dipanggil ulasan perihalan, yang berakhir dengan /**Mulakan dengan*/.
Komen penerangan membolehkan anda membenamkan maklumat tentang program dalam program. Anda boleh menggunakan perisian alat javadoc untuk menjana maklumat dan mengeluarkannya ke fail HTML.
Komen penjelasan membolehkan anda merekodkan maklumat tentang program anda dengan cara yang lebih komprehensif.
teg javadoc
Perisian alat javadoc mengenali teg berikut:
| Teg | Penerangan | Contoh |
|---|---|---|
| @pengarang | Kenal pasti pengarang kelas | @penerangan pengarang |
| @tidak digunakan | Namakan kelas atau ahli yang telah tamat tempoh | @huraian tidak digunakan lagi |
| {@docRoot} | Tentukan laluan ke direktori akar dokumen semasa | Laluan Direktori |
| @pengecualian | Tandakan pengecualian yang dilemparkan oleh kelas | @penerangan nama pengecualian pengecualian |
| {@inheritDoc} | Anotasi yang diwarisi daripada kelas induk langsung | Mewarisi ulasan daripada superclass segera. |
| {@link} | Sisipkan pautan ke topik lain | {@teks nama pautan} |
| {@linkplain} | Masukkan pautan ke topik lain, tetapi paparkan pautan dalam fon teks biasa | Memasukkan pautan dalam talian ke topik lain. |
| @param | Terangkan parameter kaedah | @param parameter-nama penjelasan |
| @kembali | Terangkan jenis nilai pulangan | @kembali penjelasan |
| @lihat | Tentukan pautan ke topik lain | @lihat sauh |
| @siri | Terangkan atribut bersiri | @penerangan bersiri |
| @serialData | Terangkan data yang ditulis melalui kaedah writeObject() dan writeExternal() | @serialData penerangan |
| @serialField | Terangkan komponen ObjectStreamField | @serialField name type description |
| @sejak | Tandai apabila perubahan tertentu diperkenalkan | @sejak dikeluarkan |
| @melempar | Sama seperti tag @exception. | Teg @throws mempunyai maksud yang sama dengan teg @exception. |
| {@nilai} | Memaparkan nilai pemalar, yang mestilah sifat statik. | Memaparkan nilai pemalar, yang mestilah medan statik. |
| @versi | Nyatakan versi kelas | @version info |
Komen dokumentasi
Selepas pembukaan /**, baris atau baris pertama adalah mengenai kelas, pembolehubah dan kaedah Yang utama huraian
Selepas, anda boleh menyertakan satu atau lebih jenis tag @. Setiap teg @ mesti berada di permulaan baris baharu atau diikuti segera dengan asterisk (*) pada permulaan baris
Berbilang teg daripada jenis yang sama hendaklah dikumpulkan bersama. Contohnya, jika anda mempunyai tiga teg @see, letakkannya satu demi satu.
Berikut ialah contoh ulasan penerangan kelas:
/*** This class draws a bar chart. * @author Zara Ali * @version 1.2 */
Apakah output javadoc?
Alat javadoc mengambil kod sumber program Java anda sebagai input dan output sesuatu yang mengandungi fail HTML untuk komen program anda.
Maklumat untuk setiap kelas akan berada dalam fail HTML yang berasingan. Javadoc juga boleh mengeluarkan struktur dan indeks pokok yang diwarisi.
Memandangkan pelaksanaan javadoc berbeza, kerja mungkin berbeza Anda perlu menyemak versi sistem pembangunan Java anda dan butiran lain untuk memilih versi Javadoc yang sesuai.
Contoh
Berikut ialah contoh mudah menggunakan ulasan penerangan. Perhatikan bahawa setiap ulasan mendahului item yang diterangkan.
Selepas pemprosesan javadoc, ulasan untuk kelas SquareNum akan ditemui dalam 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);
}
}adalah seperti berikut, gunakan alat javadoc untuk memproses fail 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 $
