เป็นสิ่งสำคัญมากสำหรับนักพัฒนาโปรแกรมที่จะแนบความคิดเห็นเข้ากับรหัส ด้วยการพัฒนาเทคโนโลยีโปรแกรมเมอร์จะต้องเขียนความคิดเห็นรหัสระหว่างการพัฒนาโครงการซึ่งเอื้อต่อการเขียนและการใช้รหัสที่ตามมา
ข้อกำหนดพื้นฐาน:
1. แบบฟอร์มความคิดเห็นแบบครบวงจร
ตลอดแอปพลิเคชันให้ใช้สไตล์ที่มีเครื่องหมายวรรคตอนและโครงสร้างที่สอดคล้องกันเพื่อสร้างคำอธิบายประกอบ หากคุณพบว่าข้อมูลจำเพาะคำอธิบายประกอบของพวกเขาแตกต่างจากเอกสารนี้ในโครงการอื่น ๆ ให้เขียนรหัสตามข้อกำหนดนี้และไม่พยายามแนะนำข้อกำหนดใหม่ในระบบข้อกำหนดที่กำหนดไว้
2. เนื้อหาความคิดเห็นถูกต้องและรัดกุม
เนื้อหาควรง่ายชัดเจนและแม่นยำและควรป้องกันความหมายจากความคลุมเครือของความคิดเห็น ความคิดเห็นที่ไม่ถูกต้องไม่เพียง แต่ไร้ประโยชน์ แต่ยังเป็นอันตราย
3. ความคิดเห็นพื้นฐาน (ต้องเพิ่ม)
(a) ความคิดเห็นสำหรับคลาส (อินเตอร์เฟส)
(b) ความเห็นของคอนสตรัคเตอร์
(c) ความคิดเห็นเกี่ยวกับวิธีการ
(d) ความคิดเห็นของตัวแปรทั่วโลก
(e) หมายเหตุสำหรับฟิลด์/แอตทริบิวต์: รหัสง่าย ๆ ทำให้ความคิดเห็นง่าย ๆ เนื้อหาความคิดเห็นไม่เกิน 10 คำและนอกจากนี้ยังคงอยู่ในวัตถุหรือ
วิธีการ getter และ setter ของวัตถุ VO ไม่จำเป็นต้องแสดงความคิดเห็น สำหรับรูปแบบความคิดเห็นเฉพาะโปรดดูตัวอย่างต่อไปนี้
4. ต้องเพิ่มความคิดเห็นพิเศษ (ต้องเพิ่ม)
(a) อัลกอริทึมทั่วไปจะต้องแสดงความคิดเห็น
(b) ความคิดเห็นจะต้องทำในรหัสที่ไม่ชัดเจน
(c) เพิ่มความคิดเห็นไปยังเครื่องหมายการปรับเปลี่ยนที่การปรับเปลี่ยนรหัส
(d) แสดงความคิดเห็นในรหัสที่ประกอบด้วยลูปและสาขาตรรกะ
(e) อินเทอร์เฟซที่มีให้กับผู้อื่นจะต้องแสดงความคิดเห็นในรายละเอียด
หมายเหตุ: ไม่มีตัวอย่างสำหรับรูปแบบความคิดเห็นประเภทนี้ รูปแบบคำอธิบายประกอบที่เฉพาะเจาะจงถูกกำหนดโดยตัวคุณเองและเนื้อหาคำอธิบายประกอบจะต้องมีความแม่นยำและรัดกุม
5. รูปแบบความคิดเห็น:
1) ความคิดเห็นบรรทัดเดียว: "// ... "
2) บล็อกความคิดเห็น: "/*...*/"
3) ความคิดเห็นของเอกสาร: "/** ...*/"
4) Javadoc Comment Tag ไวยากรณ์
@author คำอธิบายของคลาสระบุผู้เขียนที่พัฒนาโมดูลของชั้นเรียน
@Version คำอธิบายของคลาสระบุเวอร์ชันของโมดูลของคลาส
@see อ้างอิงหันไปหาคำอธิบายของคลาสคุณสมบัติและวิธีการนั่นคือหัวข้อที่เกี่ยวข้อง
@Param คำอธิบายวิธีคำอธิบายของพารามิเตอร์ในวิธีการ
@return คำอธิบายวิธีการคำอธิบายวิธีการส่งคืนค่า
@Exception คำอธิบายของคำอธิบายวิธีการของข้อยกเว้นที่อาจถูกโยนโดยวิธีการ
6. ตัวอย่าง:
/** สร้างคลาสเครื่องมือสำหรับการจัดการอาร์เรย์ซึ่งมีฟังก์ชั่นทั่วไปนี้สำหรับการทำงานอาร์เรย์: ค่ามากที่สุด @author Zhang San @เวอร์ชัน v. */ คลาสสาธารณะ arraytool {/ ** รับค่าสูงสุดของอาร์เรย์การสร้าง @param arr ได้รับอาร์เรย์ขององค์ประกอบของ int type @return ค่าองค์ประกอบสูงสุดของอาร์เรย์ */ public int getMax (int arr) {int max =; กลับมาสูงสุด; -ป้อนคำสั่งดังที่แสดงด้านล่าง:
จากนั้นตรวจสอบในไดเรกทอรีต่อไปนี้และในที่สุดคลิก index.html:
เนื้อหาข้างต้นแบ่งปันข้อกำหนดความคิดเห็นของรหัส Java กับคุณโดยหวังว่ามันจะเป็นประโยชน์กับคุณ