Sangat penting bagi pengembang program untuk melampirkan komentar ke kode. Dengan pengembangan teknologi, programmer harus diminta untuk menulis komentar kode selama pengembangan proyek, yang kondusif untuk penulisan dan penggunaan kode selanjutnya.
Persyaratan Dasar:
1. Formulir Komentar Terpadu
Sepanjang aplikasi, gunakan gaya dengan tanda baca dan struktur yang konsisten untuk membangun anotasi. Jika Anda menemukan bahwa spesifikasi anotasi mereka berbeda dari dokumen ini dalam proyek lain, tulis kode sesuai dengan spesifikasi ini dan tidak berusaha untuk memperkenalkan spesifikasi baru ke dalam sistem spesifikasi yang ditetapkan.
2. Konten komentar akurat dan ringkas
Konten harus sederhana, jelas dan akurat, dan artinya harus dicegah dari ambiguitas komentar. Komentar yang salah tidak hanya tidak berguna tetapi juga berbahaya.
3. Komentar Dasar (harus ditambahkan)
(a) Komentar untuk kelas (antarmuka)
(B) Komentar Konstruktor
(c) Komentar tentang metode
(d) Komentar variabel global
(e) Catatan untuk bidang/atribut: kode sederhana membuat komentar sederhana, konten komentar tidak lebih dari 10 kata, dan di samping itu, objek bertahan atau
Metode pengambil dan setter dari objek VO tidak perlu dikomentari. Untuk format komentar tertentu, silakan merujuk ke contoh -contoh berikut.
4. Komentar khusus harus ditambahkan (harus ditambahkan)
(a) Algoritma tipikal harus dikomentari.
(B) Komentar harus dibuat dalam kode yang tidak jelas.
(c) Tambahkan komentar ke tanda modifikasi pada modifikasi kode.
(d) Komentar dalam kode yang terdiri dari loop dan cabang logis.
(e) Antarmuka yang diberikan kepada orang lain harus dikomentari secara rinci.
Catatan: Tidak ada contoh untuk jenis format komentar ini. Format anotasi spesifik didefinisikan oleh diri Anda sendiri, dan konten anotasi diperlukan untuk menjadi akurat dan ringkas.
5. Format Komentar:
1) Komentar satu baris: "// ..."
2) Blokir Komentar: "/*...*/"
3) Komentar Dokumen: "/** ...*/"
4) Sintaks Tag Komentar Javadoc
@Author Deskripsi kelas menunjukkan penulis yang mengembangkan modul kelas
@Version Deskripsi kelas menunjukkan versi modul kelas
@See Referensi beralih ke deskripsi kelas, properti, dan metode, yaitu topik terkait
@param Deskripsi Deskripsi Metode Parameter dalam Metode
@Kembalinya Deskripsi Metode Deskripsi Metode Nilai Pengembalian
@Exception Deskripsi Metode Deskripsi Pengecualian Yang Mungkin Dilemparkan Dengan Metode
6. Contoh:
/** Buat kelas alat untuk memanipulasi array, yang berisi fungsi umum ini untuk array operasi: nilai terbanyak. @Author zhang san @versi v. */ kelas publik arraytool {/ ** Dapatkan nilai maksimum dari array pembentukan @param arr menerima array elemen int int @return nilai elemen maksimum array */ public int getmax (int arr) {int max =; return max; }}Masukkan perintah seperti yang ditunjukkan di bawah ini:
Kemudian periksa di direktori berikut dan akhirnya klik Index.html:
Konten di atas membagikan spesifikasi komentar kode java dengan Anda, berharap ini akan membantu Anda.