ฉันได้ดูเอกสาร javadoc บนเว็บไซต์ของ Sun พยายามค้นหาว่ามีแท็ก javadoc ซึ่งสามารถใช้ในการจัดทำเอกสารประเภทลายเซ็นทั่วไปของคลาสหรือวิธีการได้หรือไม่
สิ่งที่ชอบ@typeparam
คล้ายกับปกติ@param
แต่ที่ใช้บังคับกับประเภทเช่นเดียวกับวิธีเช่น
/**
* @typeparam T This describes my type parameter
*/
class MyClass<T> {
}
ฉันสงสัยว่าไม่มีแท็กดังกล่าว - ฉันไม่สามารถพูดถึงมันได้ทุกที่และเอกสาร JavaSE API ไม่แสดงเครื่องหมายใด ๆ แต่ดูเหมือนว่าจะไม่สนใจเลย ใครบางคนทำให้ฉันใช่ไหม
7
หากต้องการเขียน javadocs ที่เหมาะสม
—
Timo Willemsen
โปรดทราบว่าสำหรับคลาสส่วนใหญ่ไม่มีอะไรน่าสนใจที่จะพูดเกี่ยวกับพารามิเตอร์ type เนื่องจากพารามิเตอร์ type นั้นถูกกำหนดโดยวิธีการที่ปรากฏในวิธีการของวัตถุ ฉันจะข้าม
—
Kevin Bourrillion
@param <T>
เวลาส่วนใหญ่และใช้เฉพาะเมื่อมันไม่ชัดเจนจริงๆ
ฉันเห็นสิ่งที่คุณพูด แต่ด้วยเหตุผลนั้นเช่นเดียวกันกับการใช้
—
skaffman
@param
พารามิเตอร์ method มาตรฐานการเข้ารหัสของ Sun บอกอย่างชัดเจนว่า@param
ควรใช้แม้ว่าความหมายของพารามิเตอร์ method จะชัดเจน
นอกจากนั้น การเขียนโปรแกรม API ที่ดีควรจัดทำเป็นเอกสารด้วยตนเองเท่าที่จะทำได้ นั่นหมายความว่า api ไม่ต้องการเอกสารหรือไม่ ไม่
—
Timo Willemsen
เอกสาร @paramให้คำแนะนำสำหรับพารามิเตอร์ชนิด โปรดทราบว่า Oracle สามารถทำงานโฆษณาเอกสารนี้ได้ดีขึ้น
—
Michael Allan