คำถามติดแท็ก javadoc

การใช้ JavaDoc ฉันจะอ้างอิงค่าของฟิลด์คงที่สุดท้ายในคลาสได้อย่างไร ฉันต้องการในตัวอย่างนี้ถูกแทนที่ด้วยค่าของสนาม???STATIC_FIELD /** * This is a simple class with only one static field with the value ???. */ public class Simple { /** * We can reference the value with {@value} here, * but how do we reference it in the class JavaDoc? */ public static final …

100 java  documentation  javadoc 

ฉันมักจะพบว่าตัวเองกลืนไม่เข้าคายไม่ออกเมื่อเขียน javadoc สำหรับคุณสมบัติ / สมาชิกของคลาส POJO แบบ "ธรรมดา" ที่มี แต่คุณสมบัติและตัวรับและตัวตั้งค่า (แบบ DTO) .... 1) เขียน javadoc สำหรับคุณสมบัติ หรือ ... 2) เขียน javadoc สำหรับ getter ถ้าฉันเขียน javadoc สำหรับคุณสมบัติ IDE (Eclipse) ของฉันจะ (ตามธรรมชาติ) ไม่สามารถแสดงสิ่งนี้ได้เมื่อฉันเข้าถึง POJO ในภายหลังผ่านการเติมโค้ด และไม่มีแท็ก javadoc มาตรฐานที่ให้ฉันเชื่อมโยง getter-javadoc กับคุณสมบัติที่แท้จริงของ javadoc ตัวอย่าง: public class SomeDomainClass { /** * The name of …

93 java  javadoc 

ฉันกำลังย้ายจาก Eclipse ไปยัง Intellij Idea สิ่งหนึ่งที่ฉันยังคิดไม่ออกคือการเติมข้อความอัตโนมัติของ@authorแท็ก JavaDoc เมื่อพิมพ์@aEclipse มีข้อเสนอสองข้อ: @author - author name @author ฉันจะบรรลุข้อเสนอแรกใน Intellij ได้อย่างไร (เป็นไปได้หรือไม่?) และถ้าเป็นไปได้ฉันจะเปลี่ยนเทมเพลตของสิ่งที่แทรกสำหรับตัวยึดชื่อผู้แต่งได้อย่างไร

93 intellij-idea  javadoc 

สมมติว่าเป็นส่วนหนึ่งของการบันทึกโค้ดของคุณ (Javadoc) คุณต้องการระบุว่าความสัมพันธ์ระหว่างองค์ประกอบที่ใช้การเยื้องลึก ฉันจะสร้างรายการที่ซ้อนกันเป็น: องค์ประกอบบางอย่าง องค์ประกอบอื่น ๆ แต่องค์ประกอบอื่น ๆ

90 documentation  javadoc  indentation  nested-lists 

ฉันได้ดูข้อมูลอ้างอิง JavaDocแล้วและในขณะที่ฉันเข้าใจความแตกต่างพื้นฐานระหว่าง@see(ลิงก์ต่างๆ) และ{@inheritDoc}(การส่งออกความคิดเห็น JavaDoc ระดับสูง) ฉันต้องการคำชี้แจงเกี่ยวกับวิธีการใช้งานจริง ใน Eclipse IDE เมื่อฉันเลือก "สร้างความคิดเห็นขององค์ประกอบ" สำหรับวิธีการที่สืบทอดมา (จากอินเตอร์เฟสหรือ toString () แทนที่และอื่น ๆ ) มันจะสร้างข้อคิดเห็นต่อไปนี้ /* (non-Javadoc) * @see SomeClass#someMethod() */ หากฉันจำเป็นต้องสร้าง JavaDoc ฉันควรทิ้งไว้ที่นั่นแทนที่@seeด้วย{@inheritDoc}หรือเปลี่ยนเป็น JavaDoc โดยสุจริตดังนี้: /** * {@inheritDoc} */ และเมื่อฉันทำเช่นนั้นฉันควรยังคงแฟล็ก class # method ไว้หรือไม่

90 java  javadoc  comments 

Exit code: 1 - javadoc: error - The code being documented uses packages in the unnamed module, but the packages defined in https://docs.oracle.com/en/java/javase/11/docs/api/ are in named modules. มีใครสามารถทำให้ javadoc ทำงานได้โดยไม่ต้องเปลี่ยนเวอร์ชั่นต้นฉบับเป็น 1.8 (ตามที่แนะนำในฟอรัมอื่น) ฉันใช้ JDK v11.0.5 และยังมีปัญหาอยู่ (เช่นเดียวกับ JDK 12+) แก้ไข: ข้อผิดพลาดนี้เกิดจาก maven และโยนโดย maven-javadoc-plugin ฉันไม่สามารถใช้งานกับ JDK 11+ ได้แม้ว่าจะมีการ<source>8</source>กำหนดค่าก็ตาม

13 java  maven  javadoc  java-11  maven-javadoc-plugin 

เป็นวิธีการอย่างใดอย่างหนึ่งควรเอกสารพารามิเตอร์Java Record ? ฉันหมายถึงพารามิเตอร์ที่ลงท้ายด้วยการเป็นพารามิเตอร์ตัวสร้างฟิลด์คลาส ฉันเหนื่อย: /** * @param name the name of the animal * @param age the age of the animal */ public record Animal(String name, int age) { } แต่ IntelliJ IDEA ตั้งค่าสถานะ@params เป็นข้อผิดพลาด ฉันไม่พบตัวอย่างออนไลน์เกี่ยวกับวิธีการทำงานของสิ่งนี้ ที่อยู่ใกล้ผมพบว่าการอภิปรายเป็นhttps://bugs.openjdk.java.net/browse/JDK-8225055 ฉันพบการทดสอบหน่วย บางอย่างใน JDK ที่ดูเหมือนจะบอกเป็นนัยว่าสิ่งนี้ควรใช้งานได้ บางทีนี่อาจเป็นข้อผิดพลาดของ IDE? ฉันใช้ OpenJDK 14 + 36-1461, IDEA …

12 java  intellij-idea  javadoc  java-14  java-record