การจัดการกับแท็ก @since ของ Javadoc

เครื่องมือ API จัดเตรียมการสนับสนุนสำหรับการจัดการแท็ก Javadoc @since บนอิลิเมนต์ใหม่ที่ถูกเพิ่มเข้ากับ API (ชนิด, เมธอด, ฟิลด์ เป็นต้น) อิลิเมนต์ใหม่ API สามารถเป็นชนิดใหม่ที่เพิ่มให้กับแพ็กเกจ API ชนิดใหม่ที่เพิ่มให้กับชนิด API เมธอดใหม่ที่เพิ่มให้กับชนิด API หรือฟิลด์ใหม่ที่เพิ่มให้กับชนิด API การเพิ่มเมธอดเป็นกรณีพิเศษที่การเพิ่มเมธอดสามารถเพิ่มเมธอดให้กับเทป ซึ่ง override เมธอดคลาสของพาเรนต์ การนำเมธอดอินเตอร์เฟสของพาเรนต์ไปใช้งาน หรือการเปลี่ยนลายเซ็นของเมธอดที่มีอยู่

หมายเหตุ: ข้อมูลแท็ก @since ไม่ได้กระจายผ่านการนำไปใช้งานหรือการแบ่งคลาสย่อย แต่ละอิลิเมนต์ที่เพิ่มให้กับ API ถูกคาดการณ์ให้กับแท็ก @since ของตนเองและข้อมูลเวอร์ชัน

เครื่องมือจัดเตรียมการตรวจสอบความถูกต้องต่อไปนี้สำหรับแท็ก @since:

การกำหนดค่าตามความชอบสำหรับการจัดการกับแท็ก @since สามารถเปลี่ยนแปลงได้บนหน้าการกำหนดค่าตามความชอบสำหรับ เปิดหน้าการกำหนดค่าตามความชอบสำหรับคอนโซล การพัฒนาปลั๊กอิน > ข้อผิดพลาด/คำเตือนเกี่ยวกับ API

ไม่มีแท็ก @since

อิลิเมนต์ API ใหม่ทุกตัวที่ตรวจพบจะถูกตรวจสอบโดยเครื่องมือเพื่อให้มั่นใจว่ามีแท็ก @since หากอิลิเมนต์ใหม่ไม่มีแท็ก @since อิลิเมนต์นั้นจะถูกแฟล็กเป็นสิ่งที่ต้องการและเวอร์ชันสำหรับแท็กจะถูกนำเสนอ เวอร์ชันที่นำเสนอสำหรับแท็กใหม่จะเป็นเวอร์ชันปัจจุบันของบันเดิล - ยกเว้นในกรณีของการหยุดการเปลี่ยนแปลง API ที่เวอร์ชันของบันเดิล ยังต้องการอัพเดต หากเวอร์ชันของบันเดิลยังต้องการอัพเดต เวอร์ชันที่นำเสนอสำหรับการขาดหายไปของแท็ก @since จะเป็นเวอร์ชันบันเดิล ที่นำเสนอ

โปรดพิจารณาตัวอย่างต่อไปนี้: เรามีบันเดิล A ด้วยเวอร์ชัน 1.0.0 และเรามีคลาส C ที่ถูกเพิ่มในเวอร์ชัน 1.1.0 ของ A ที่มีเมธอด m1()

แท็ก @since ผิดรูปแบบ

อิลิเมนต์ใหม่สามารถมีแท็ก @since ที่ตรวจสอบความสอดคล้องกันเพื่อมั่นใจว่าอิลิเมนต์ถูกกำหนดไว้อย่างถูกต้อง เครื่องมือ API ตรวจสอบว่า แท็ก @since ทั้งหมดเป็นไปตามรูปแบบทั่วไปดังนี้:

[@since] [pre-amble] [2 part version] [post-amble]

โปรดพิจารณาตัวอย่างแท็ก @since ต่อไปนี้:

เวอร์ชันของแท็ก @since ไม่ถูกต้อง

อิลิเมนต์ใหม่ยังสามารถมีแท็ก @since ถูกตรวจสอบความถูกต้อง แท็ก @since ถูกพิจารณาว่าถูกต้อง หากข้อมูลเวอร์ชันในแท็กตรงกับเวอร์ชันของบันเดิล

โปรดพิจารณาตัวอย่างต่อไปนี้ซึ่งเราเพิ่มเมธอด m2() ใหม่ให้กับคลาส API ในบันเดิล A ที่มีเวอร์ชันคือ 1.0.0:

ภารกิจที่เกี่ยวข้อง
การตั้งค่าเบสไลน์

การอ้างถึงที่เกี่ยวข้อง
การกำหนดค่าตามความชอบสำหรับ API พื้นฐาน
การกำหนดค่าตามความชอบสำหรับข้อผิดพลาดและคำเตือนเกี่ยวกับ API