การนิยามข้อจำกัดของ API

เครื่องมือ API จัดเตรียมแท็ก Javadoc เพื่อทำเอกสารไว้อย่างชัดเจนและจำกัดการใช้ API ตารางต่อไปนี้คือสรุปแท็บ Javadoc ที่สนับสนุนโดยสมาชิกแต่ละรายและซีแมนทิกส์ของแต่ละแท็ก

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

แท็กของข้อจำกัดที่สนับสนุน

  คลาส อินเตอร์เฟส เมธอด Constructor

ฟิลด์ Final

ฟิลด์ที่ไม่ใช่ฟิลด์ Final
@noimplement
-
สนับสนุน
-
-
-
-
@noextend
สนับสนุน
สนับสนุน
-
-
-
-
@noinstantiate
สนับสนุน
-
-
-
-
-
@nooverride
-
-
สนับสนุน
-
-
-
@noreference
-
-
สนับสนุน
สนับสนุน
-
สนับสนุน

ข้อจำกัดเกี่ยวซีแมนทิกส์

@noimplement

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

@noextend
บ่งชี้ว่าไคลเอ็นต์ต้องไม่ขยายคลาสหรืออินเตอร์เฟสนี้ คลาสหรืออินเตอร์เฟสใดๆ ที่ใช้คีย์เวิร์ด extends สำหรับชนิดที่เชื่อมโยงจะถูกแฟล็กด้วยปัญหา
@noinstantiate
บ่งชี้ว่าไคลเอ็นต์ต้องไม่แสดงตัวอย่างคลาสนี้ โค้ดใดๆ ที่แสดงตัวอย่างคลาสที่เชื่อมโยงด้วย constructor ใดๆ จะถูกแฟล็กด้วยปัญหา
@nooverride
บ่งชี้ว่าไคลเอ็นต์ต้องไม่ถูกประกาศเมธอดนี้อีกครั้ง คลาสย่อยใดๆ ที่นิยามเมธอดที่ override เมธอดที่เชื่อมโยงจะถูกแฟล็กไว้ด้วยปัญหา
@noreference
บ่งชี้ว่าไคลเอ็นต์ต้องอ้างอิงเมธอด constructor หรือฟิลด์ที่ไม่ใช่ final โค้ดใดๆ ที่เรียกใช้เมธอดที่เชื่อมโยงโดยตรงกับเมธอดที่เชื่อมโยงหรือ constructor หรือการอ้างถึงฟิลด์ที่ไม่ใช่ final ที่เชื่อมโยงจะถูกแฟล็กปัญหา

ภารกิจที่เกี่ยวข้อง

การตั้งค่าเบสไลน์

การอ้างถึงที่เกี่ยวข้อง

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