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

ฉันจะใช้@linkแท็กเพื่อเชื่อมโยงไปยังวิธีการได้อย่างไร ฉันต้องการเปลี่ยน: /** * Returns the Baz object owned by the Bar object owned by Foo owned by this. * A convenience method, equivalent to getFoo().getBar().getBaz() * @return baz */ public Baz fooBarBaz() ถึง: /** * Returns the Baz object owned by the Bar object owned by Foo owned by …

864 java  hyperlink  javadoc 

สิ่งที่ต้องการ: /** * See {@linktourl http://google.com} */

768 java  url  javadoc  hyperlink 

ฉันมีตัวอย่างรหัสขนาดเล็กที่ฉันต้องการรวมในความคิดเห็น Javadoc สำหรับวิธีการ /** * -- ex: looping through List of Map objects -- * <code> * for (int i = 0; i < list.size(); i++) { * Map map = (Map)list.get(i); * System.out.println(map.get("wordID")); * System.out.println(map.get("word")); * } * </code> * * @param query - select statement * @return List …

531 java  html  javadoc 

มีวิธีเพิ่มการอ้างอิงไปยังพารามิเตอร์ของวิธีการอย่างน้อยหนึ่งรายการจากเนื้อหาเอกสารวิธีหรือไม่ สิ่งที่ต้องการ: /** * When {@paramref a} is null, we rely on b for the discombobulation. * * @param a this is one of the parameters * @param b another param */ void foo(String a, int b) {...}

313 java  arguments  javadoc 

ตั้งแต่ฉันใช้ Maven ฉันสามารถสร้างและติดตั้งในโครงการที่เก็บในเครื่องของฉันที่มีแท็ก Javadoc ที่ไม่สมบูรณ์ (ตัวอย่างเช่นพารามิเตอร์ขาดหายไป) อย่างไรก็ตามเนื่องจากฉันย้ายไปยัง Java 8 (1.8.0-ea-b90) Maven นั้นเข้มงวดมากเกี่ยวกับแท็กเอกสารที่หายไปและแสดงข้อผิดพลาด Javadoc จำนวนมากที่เกี่ยวข้องกับปัญหา Javadoc เมื่อฉันพยายามสร้างหรือติดตั้งโครงการที่ Javadoc ไม่ได้ "สมบูรณ์แบบ" บางโครงการที่ฉันพยายามรวบรวมและติดตั้งในพื้นที่เก็บข้อมูลในพื้นที่ของฉันคือโครงการของ บริษัท อื่นซึ่งฉันไม่สามารถควบคุมได้ ดังนั้นการแก้ปัญหาเพียงแก้ไข Javadocs ทั้งหมดในโครงการเหล่านี้ทั้งหมดจึงดูเหมือนจะไม่เป็นไปได้ในสถานการณ์ของฉัน นี่เป็นส่วนเล็ก ๆ ของผลลัพธ์ที่ฉันเห็นเมื่อฉันดำเนินการmvn clean package installในโครงการของฉัน: [INFO] ------------------------------------------------------------------------ [INFO] BUILD FAILURE [INFO] ------------------------------------------------------------------------ [INFO] Total time: 9.026s [INFO] Finished at: Mon Apr 08 21:06:17 CEST …

312 java  maven  migration  java-8  javadoc 

ปลั๊กอิน ADT r17 เวอร์ชันใหม่สำหรับ Eclipse ที่เพิ่มคุณสมบัติเพื่อตั้งค่าการพึ่งพา JAR โดยอัตโนมัติ ไฟล์. jar ใด ๆ ในโฟลเดอร์ / libs จะถูกเพิ่มในการกำหนดค่าบิลด์ทันที น่าเสียดายที่ classpath ของ Android Dependencies ไม่สามารถแก้ไขได้ ฉันจะแนบ javadoc และแหล่งที่มาเข้ากับ. jar (จาก / libs โฟลเดอร์) ที่แทรกโดยอัตโนมัติได้อย่างไร

254 android  eclipse  adt  javadoc 

ขณะนี้ฉันกำลังอ้างอิงวิธีในคลาสอื่นด้วยไวยากรณ์ Javadoc นี้: @see {@link com.my.package.Class#method()} และในสิ่งที่ฉันเข้าใจจากเอกสารนี้เป็นวิธีที่ถูกต้องในการทำสิ่งนี้ แต่ตอนนี้เป็นส่วนที่ตลกหรือน่าหงุดหงิด เมื่อฉันสร้าง javadoc นี้ฉันก่อนอื่นได้รับข้อผิดพลาดดังต่อไปนี้: warning - Tag @see:illegal character: "123" in "{@link com.my.package.Class#method()}" warning - Tag @see:illegal character: "64" in "{@link com.my.package.Class#method()}" warning - Tag @see: reference not found: {@link com.my.package.Class#method()} รหัส HTML ที่สร้างขึ้นนี้คือ: "," <code>com.my.package.Class#method()}</code> "," และแน่นอนฉันไม่มีลิงค์ ใครสามารถบอกฉันว่าเกิดอะไรขึ้นและคำแนะนำเกี่ยวกับวิธีแก้ไขปัญหานี้ได้อย่างไร ตามตารางอักขระ ASCII 123 และ …

238 java  javadoc 

เมื่อพยายามที่จะสร้างความคิดเห็น Javadoc ระดับแพคเกจวิธีการที่ต้องการคืออะไร? คุณทำอะไร? package-info.java ข้อดี บทความที่ใหม่กว่า จุดด้อย การละเมิดคลาส - คลาสมีไว้สำหรับรหัสไม่ใช่เพื่อความคิดเห็นเท่านั้น package.html ข้อดี ส่วนขยาย HTML หมายถึงไม่ใช่รหัส เน้นไวยากรณ์ในตัวแก้ไขข้อความ / ของ IDE จุดด้อย ไม่มี? สำหรับฉันฉันใช้ Package.html เสมอ แต่ฉันสงสัยว่ามันเป็นตัวเลือกที่ถูกต้องหรือไม่

230 java  javadoc 

ฉันสามารถใช้ปุ่มทางลัดในสตูดิโอ Android เพื่อสร้างความคิดเห็น javadoc ได้หรือไม่? ถ้าไม่เป็นวิธีที่ง่ายที่สุดในการสร้างความคิดเห็น javadoc คืออะไร?

204 android-studio  javadoc 

ความแตกต่างระหว่างอะไร /** * comment * * */ และ /* * * comment * */ ใน Java? ฉันควรใช้เมื่อใด

192 java  comments  javadoc 

มีคนบอกความแตกต่างระหว่าง javadoc @seeกับ{@link}ฉันได้ไหม หรือเมื่อไรที่ควรใช้อันไหน?

184 java  javadoc 

ฉันรู้ว่ามันไม่ใช่ประเด็นสำคัญที่สุดของปัญหา แต่ฉันเพิ่งรู้ว่าฉันสามารถใส่บล็อกความคิดเห็น javadoc ก่อนหรือหลังการเพิ่มความคิดเห็น สิ่งที่เราต้องการนำมาใช้เป็นมาตรฐานการเข้ารหัส? /** * This is a javadoc comment before the annotation */ @Component public class MyClass { @Autowired /** * This is a javadoc comment after the annotation */ private MyOtherClass other; }

184 java  coding-style  annotations  javadoc  code-documentation 

ใน Java APIs ฉันสามารถเห็นความคิดเห็น Javadoc สำหรับแพ็คเกจ ฉันจะวางความคิดเห็น Javadoc กับเอกสารแพคเกจได้อย่างไร?

182 java  packages  javadoc 

ฉันจะหนีจาก@สัญลักษณ์ใน javadoc ได้อย่างไร ฉันพยายามใช้ภายใน{@code}แท็กซึ่งอยู่ใน<pre>แท็ก ฉันลองใช้@ลำดับhtml escape แล้ว แต่นั่นไม่ได้ผล

180 java  escaping  javadoc 

ฉันกำลังใช้ Maven (และการรวม Maven Eclipse) เพื่อจัดการการพึ่งพาสำหรับโปรเจ็กต์ Java ของฉันใน Eclipse คุณสมบัติดาวน์โหลดอัตโนมัติสำหรับไฟล์ JAR จากที่เก็บ Maven เป็นตัวช่วยประหยัดเวลาจริง น่าเสียดายที่มันไม่ได้มีเอกสารประกอบ API และซอร์สโค้ด ฉันจะตั้งค่า Maven ให้รับไฟล์แนบจากแหล่งที่มาและ javadoc โดยอัตโนมัติและลงทะเบียนด้วย Eclipse ได้อย่างไร

176 eclipse  maven-2  javadoc