@param
แท็ก @param สามารถเก็บถาวรพารามิเตอร์เดียวของวิธีการหรือตัวสร้างหรือพารามิเตอร์ประเภทของคลาสเก็บถาวรอินเตอร์เฟสและวิธีการทั่วไป เมื่อใช้แท็ก @param เราควรใช้หนึ่งในแท็กสำหรับแต่ละพารามิเตอร์ของวิธีการ คำแรกในแต่ละย่อหน้าจะถือเป็นชื่อพารามิเตอร์ในขณะที่ส่วนที่เหลือจะได้รับการยกย่องว่าเป็นคำอธิบายของมัน:
@param สูงสุดจำนวนคำที่อ่าน
เมื่อพารามิเตอร์ประเภทการเก็บถาวรเราควรเพิ่ม <และ> ลงในทั้งสองด้านของชื่อพารามิเตอร์ประเภท:
@param 体中国中国中国中国
อย่างไรก็ตามพารามิเตอร์ประเภทมักไม่จำเป็นต้องใช้เอกสารที่ชัดเจนเนื่องจากมีทั้งหมดชัดเจนมาก
@ ดู
@see แท็กสามารถสร้างการอ้างอิงข้ามที่เชื่อมโยงกับเอกสาร Javadoc อื่น ๆ เราสามารถตั้งชื่อตัวระบุใด ๆ หลังจากแท็กแม้ว่าเราจะต้องมีคุณสมบัติครบถ้วน ตัวอย่างเช่นโดยปกติจะสามารถตั้งชื่อได้ด้วยชื่อง่าย ๆ ของสมาชิกของคลาส แต่ถ้าสมาชิกเป็นวิธีการโอเวอร์โหลดเราต้องระบุรุ่นที่โอเวอร์โหลดโดยการแจกแจงประเภทของแต่ละพารามิเตอร์ เราสามารถใช้ชื่อที่ไม่มีคุณสมบัติเพื่อระบุอินเทอร์เฟซหรือคลาสภายในแพ็คเกจปัจจุบัน แต่เราต้องใช้ชื่อที่ผ่านการรับรองอย่างสมบูรณ์เพื่อระบุประเภทในแพ็คเกจอื่น ๆ เราสามารถระบุสมาชิกประเภทโดยใช้ # ก่อนชื่อสมาชิก นี่คือทั้งหมดที่ถูกต้อง @ ดูรูปแบบแท็ก:
@See #GetName @SEE ATTR @See com.magic.attr.attr @See Com.magic.attr.deck#deck-size @See Com.magic.attr.attr#getName @See com.magic.attr.attr#attr com.magic.attr.attr#attr (สตริง, วัตถุ) @see com.magic.attr @see แอตทริบิวต์ @See "Almanac ของนักพัฒนา Java"
แบบฟอร์มแรกหมายถึงวิธีการที่เรียกว่า getName ซึ่งอยู่ในคลาสหรืออินเตอร์เฟสเดียวกันกับคำอธิบายประกอบเอกสารหรือในชั้นเรียนโดยรอบหรืออินเทอร์เฟซโดยรอบ ไวยากรณ์ดังกล่าวสามารถนำไปใช้กับตัวสร้างและฟิลด์ แบบฟอร์มที่สองหมายถึงคลาสในแพ็คเกจปัจจุบันหรือคลาสในแพ็คเกจคู่มือบางอย่าง แบบฟอร์มที่สามหมายถึงคลาสโดยใช้ชื่อที่ผ่านการรับรองอย่างสมบูรณ์
4 รูปแบบสุดท้ายของ @see อ้างถึงสมาชิกโดยที่สองคนแรกเป็นเรื่องเกี่ยวกับโดเมน (Deck-Siz Day และ Method (getName) เราสามารถใช้ชื่อวิธีการโดยตรงเพราะมีวิธีการ getName เพียงวิธีเดียวเท่านั้นที่กำหนดไว้ในคลาส ATTR คำคมที่เราต้องการอ้างถึง
แบบฟอร์ม @see ถัดไปนำไปสู่ผู้อ่านไปยังแพ็คเกจเฉพาะ: com.magic.attro
สองรูปแบบสุดท้ายช่วยให้เราสามารถอ้างถึงเอกสารอื่น ๆ ในหมู่พวกเขาก่อนหน้านี้ใช้เพื่อกำหนดลิงก์และหลังใช้เครื่องหมายคำพูดเพื่อแนบชื่อเอกสาร เราสามารถใช้ทั้งสองรูปแบบเพื่อนำผู้อ่านไปยังเอกสารอื่น ๆ เช่นคู่มือที่สมบูรณ์
แบบฟอร์ม @see (ทุกรูปแบบยกเว้นสองรูปแบบสุดท้ายด้านบน) ที่ชื่อเอนทิตีภาษาสามารถตามด้วยฉลาก ในเอกสารที่สร้างขึ้นชื่อฉลากนี้จะแทนที่ชื่อของเอนทิตี ตัวอย่างเช่น:
@ ดูชื่อ #getNameattribute
ลิงค์ไปยังเอกสารของ getName จะถูกสร้างขึ้น แต่ข้อความที่แสดงเป็น "ชื่อแอตทริบิวต์" แทน "getName" โดยปกติแล้วเราควรใช้ชื่อจริงของสมาชิก แต่คุณสมบัติที่แสดงที่นี่มีประโยชน์เป็นครั้งคราว