ฉันต้องการทราบวิธีที่ดีที่สุดในการเพิ่มความคิดเห็นเพื่อระบุคลาสที่เลิกใช้แล้วใน Java ฉันควรลบความคิดเห็นก่อนหน้านี้ที่เพิ่มไปยังด้านบนของคลาสที่ช่วยให้โปรแกรมเมอร์อื่นทราบว่าคลาสนั้นสำหรับอะไรหรือฉันควรเพิ่มความคิดเห็นด้านล่าง?
ฉันต้องการทราบวิธีที่ดีที่สุดในการเพิ่มความคิดเห็นเพื่อระบุคลาสที่เลิกใช้แล้วใน Java ฉันควรลบความคิดเห็นก่อนหน้านี้ที่เพิ่มไปยังด้านบนของคลาสที่ช่วยให้โปรแกรมเมอร์อื่นทราบว่าคลาสนั้นสำหรับอะไรหรือฉันควรเพิ่มความคิดเห็นด้านล่าง?
คำตอบ:
วิธีที่แนะนำในการลดคลาสวิธีหรือเขตข้อมูลใน Java คือการใช้@Deprecatedคำอธิบายประกอบซึ่งมีอยู่ใน Java 5 หรือ@deprecatedแท็ก JavaDoc ซึ่งมีมาตั้งแต่ Java 1.1 Oracle มีเอกสารเกี่ยวกับข้อมูลเฉพาะเกี่ยวกับวิธีเลิกใช้ APIที่ปรากฏว่าเกี่ยวข้อง
ฉันควรลบความคิดเห็นก่อนหน้านี้ที่เพิ่มไปยังด้านบนของชั้นเรียนที่ช่วยให้โปรแกรมเมอร์อื่นรู้ว่าชั้นเรียนนั้นสำหรับหรือเพิ่มความคิดเห็นด้านล่าง?
คุณไม่ควรแก้ไขหรือลบความคิดเห็นที่มีอยู่นอกเหนือจากการเพิ่มแท็ก JavaDoc หรือคำอธิบายประกอบ รหัสที่เลิกใช้อาจยังคงใช้งานอยู่ในระบบเดิมและผู้พัฒนาระบบเหล่านั้นจำเป็นต้องเข้าถึงเอกสารที่นักพัฒนาดั้งเดิมทำในบางรูปแบบ
@Deprecatedคำอธิบายประกอบหรือ@deprecatedแท็ก JavaDoc แค่นั้น - ไม่มีอะไรอีกแล้วไม่มีอะไรเพิ่มเติม
@deprecatedแท็ก JavaDoc และคำอธิบายพร้อมกับ@Deprecatedคำอธิบายประกอบจะให้ความสว่างมากกว่าว่าทำไมเลิกใช้แล้ว ดังนั้นมันจะมีประโยชน์มากขึ้นในการใช้ทั้งสองมากกว่าแค่@Deprecatedคำอธิบายประกอบ