ตัวอย่างรหัสหลายบรรทัดในความคิดเห็น Javadoc

ฉันมีตัวอย่างรหัสขนาดเล็กที่ฉันต้องการรวมในความคิดเห็น 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 of Map objects
 */

ปัญหาคือตัวอย่างรหัสปรากฏขึ้นใน Javadoc โดยไม่มีการขึ้นบรรทัดใหม่ทำให้อ่านยาก

-- ex: looping through List of Map objects -- 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")); } 
Parameters
query - - select statement 
Returns:
List of Map objects 

ฉันเดาว่าฉันคิดผิดว่าการแท็กรหัสจะจัดการกับการขึ้นบรรทัดใหม่ วิธีที่ดีที่สุดในการจัดรูปแบบตัวอย่างรหัสในความคิดเห็น Javadoc คืออะไร?

นอกจาก<pre>แท็กที่กล่าวถึงแล้วคุณควรใช้@codeคำอธิบายประกอบ JavaDoc ซึ่งจะทำให้ชีวิตง่ายขึ้นมากเมื่อมันมาถึงปัญหาเอนทิตี HTML (โดยเฉพาะกับ Generics) เช่น:

* <pre>
* {@code
* Set<String> s;
* System.out.println(s);
* }
* </pre>

จะให้ผลลัพธ์ HTML ที่ถูกต้อง:

Set<String> s;
System.out.println(s);

ในขณะที่ละเว้นการ@codeบล็อก (หรือใช้<code>แท็ก) จะส่งผลให้ HTML เช่นนี้:

Set s;
System.out.println(s);

(สำหรับการอ้างอิงคำอธิบายแท็ก Java SE 8 สามารถพบได้ที่นี่: แท็ก Javadoc )

ฉันมีช่วงเวลาที่ยากลำบากด้วยการรวมตัวอย่างรหัสเฉพาะในความคิดเห็น javadoc ฉันต้องการแชร์สิ่งนี้
โปรดทราบสิ่งต่อไปนี้:

• การใช้<code>แท็กเก่าเพื่อป้องกันไม่ให้มีการตีความวงเล็บปีกกา
• การใช้งานของ "ใหม่" {@code ...}- แท็กเพื่อรับข้อมูลทั่วไปรวมอยู่ในการส่งออก
• การหลีกเลี่ยงการลงชื่อเข้าใช้ @ @Overrideผ่านทาง " {@literal @}Override" เนื่องจากตัวสร้าง javadoc "เอียง" ที่นั่นเนื่องจากข้อเท็จจริงที่ว่า @ ไปโดยตรงหลังจากวงเล็บปีกกาเปิด
• ลบช่องว่างด้านหน้า{@codeและ{@literalเพื่อชดเชยช่องว่างด้านในและรักษาแนวร่วม

รหัส javadoc:

/** this methods adds a specific translator from one type to another type. `
  * i.e.
  * <pre>
  * <code>new BeanTranslator.Builder()
  *   .translate(
  *     new{@code Translator<String, Integer>}(String.class, Integer.class){
  *      {@literal @}Override
  *       public Integer translate(String instance) {
  *         return Integer.valueOf(instance);
  *       }})
  *   .build();
  * </code>
  * </pre>
  * @param translator
  */

ได้รับการพิมพ์เป็น

new BeanTranslator.Builder()
  .translate(
    new Translator<String, Integer>(String.class, Integer.class){
      @Override
      public Integer translate(String instance) {
        return Integer.valueOf(instance);
      }})
  .build();

ซอร์ส java มีตัวอย่างที่ดีมากมายสำหรับสิ่งนี้ นี่คือตัวอย่างจากส่วนหัวของ "String.java":

....
 * is equivalent to:
 * <p><blockquote><pre>
 *     char data[] = {'a', 'b', 'c'};
 *     String str = new String(data);
 * </pre></blockquote><p>
 * Here are some more examples of how strings can be used:
 * <p><blockquote><pre>
 *     System.out.println("abc");
 *     String cde = "cde";
 *     System.out.println("abc" + cde);
 *     String c = "abc".substring(2,3);
 *     String d = cde.substring(1, 2);
 * </pre></blockquote>
...

ใส่รหัสหลายแถบของคุณด้วย<pre></pre>แท็ก

คุณต้องการ<pre></pre>แท็กสำหรับการขึ้นบรรทัดใหม่และ{@code ... }ด้านในจะเป็นชื่อทั่วไป แต่ไม่อนุญาตให้วางวงเล็บปีกกาเปิดในบรรทัดเดียวกันกับ<generic>แท็กเพราะทุกอย่างจะปรากฏบน 1 บรรทัดอีกครั้ง

แสดงในหนึ่งบรรทัด:

* ..
* <pre>
* {@code
* public List<Object> getObjects() {
*    return objects;
* }
* </pre>
* ..

แสดงด้วยตัวแบ่งบรรทัด:

* ..
* <pre>
* {@code
* public List<Object> getObjects() 
* {
*    return objects;
* }
* </pre>
* ..

อีกสิ่งที่แปลกคือเมื่อคุณวางวงเล็บปีกกาปิดของ{@codeมันจะได้รับการแสดง:

* ..
* <pre>
* {@code
*   public List<Object> getObjects() 
*   {
*     return objects;
*   }
* }
* </pre>
* ..

เอาท์พุท:

public List<Object> getObjects() 
{
   return objects;
}
}

/**
 * <blockquote><pre>
 * {@code
 * public Foo(final Class<?> klass) {
 *     super();
 *     this.klass = klass;
 * }
 * }
 * </pre></blockquote>
 **/

• <pre/> จำเป็นสำหรับการรักษาเส้น
• {@code จะต้องมีสายของตัวเอง
• <blockquote/> เป็นเพียงการเยื้อง

public Foo(final Class<?> klass) {
    super();
    this.klass = klass;
}

ความต้องการขั้นต่ำสำหรับรหัสที่เหมาะสมและ<pre/>{@code}

/**
 * test.
 *
 * <pre>{@code
 * <T> void test(Class<? super T> type) {
 *     System.out.printf("hello, world\n");
 * }
 * }</pre>
 */

อัตราผลตอบแทน

 <T> void test(Class<? super T> type) {
     System.out.printf("hello, world\n");
 }

และตัวเลือกโดยรอบ<blockquote/>แทรกการเยื้อง

/**
 * test.
 *
 * <blockquote><pre>{@code
 * <T> void test(Class<? super T> type) {
 *     System.out.printf("hello, world\n");
 * }
 * }</pre></blockquote>
 */

อัตราผลตอบแทน

     <T> void test(Class<? super T> type) {
         System.out.printf("hello, world\n");
     }

การแทรก<p>หรือล้อมรอบด้วย<p>และ</p>ให้คำเตือน

ฉันสามารถสร้างไฟล์ HTML ที่ดูดีด้วย snip ต่อไปนี้ซึ่งแสดงในรหัส 1

 * <pre>
 * {@code
 * A-->B
 *  \
 *   C-->D
 *    \   \
 *     G   E-->F
 * }
 *</pre>

(รหัส 1)

รหัส 1 กลายเป็นหน้า javadoc HTML ที่สร้างขึ้นในรูปที่ 1 ตามที่คาดไว้

A-->B
 \
  C-->D
   \   \
    G   E-->F

(รูปที่ 1)

อย่างไรก็ตามใน NetBeans 7.2 หากคุณกด Alt + Shift + F (เพื่อทำการฟอร์แมตไฟล์ปัจจุบัน) รหัส 1 จะเปลี่ยนเป็นรหัส 2

 * <
 * pre>
 * {@code
 * A-->B
 *  \
 *   C-->D
 *    \   \
 *     G   E-->F
 * }
 * </pre>

(รหัส 2)

ที่แรก<pre>คือตอนนี้แบ่งออกเป็นสองบรรทัด โค้ด 2 สร้างไฟล์ javadoc HTML ดังที่แสดงในรูปที่ 2

< pre> A-->B \ C-->D \ \ G E-->F

(รูปที่ 2)

คำแนะนำของ Steve B (รหัส 3) ดูเหมือนจะให้ผลลัพธ์ที่ดีที่สุดและยังคงอยู่ในรูปแบบตามที่คาดไว้แม้หลังจากกดปุ่ม Alt + Shift + F

*<p><blockquote><pre>         
* A-->B
*  \
*   C-->D
*    \   \
*     G   E-->F
* </pre></blockquote>

(รหัส 3)

การใช้ Code 3 จะสร้างเอาต์พุต javadoc HTML แบบเดียวกันดังแสดงในรูปที่ 1

นี่คือสองเซ็นต์ของฉัน

ในฐานะที่เป็นคำตอบอื่น ๆ แล้วรัฐคุณควรใช้ร่วมกับ<pre> </pre>{@code }

ใช้preและ{@code}

• ห่อโค้ดของคุณไว้ด้านใน<pre>และ</pre>ป้องกันไม่ให้โค้ดของคุณยุบลงในหนึ่งบรรทัด
• ตัดรหัสของคุณภายใน{@code }ป้องกัน<, >และทุกสิ่งในระหว่างจากหายไป สิ่งนี้มีประโยชน์อย่างยิ่งเมื่อโค้ดของคุณมีนิพจน์ทั่วไปหรือแลมบ์ดา

ปัญหาเกี่ยวกับคำอธิบายประกอบ

ปัญหาอาจเกิดขึ้นเมื่อบล็อคโค้ดของคุณมีหมายเหตุประกอบ นั่นอาจเป็นเพราะเมื่อ@เข้าสู่ระบบจะปรากฏขึ้นที่จุดเริ่มต้นของเส้น Javadoc ก็ถือว่าเป็นแท็ก Javadoc เหมือนหรือ@param @returnตัวอย่างเช่นรหัสนี้สามารถแยกวิเคราะห์ไม่ถูกต้อง:

/**
 * Example usage:
 *
 * <pre>{@code
 * @Override
 * public void someOverriddenMethod() {

รหัสด้านบนจะหายไปอย่างสมบูรณ์ในกรณีของฉัน

ในการแก้ไขปัญหานี้บรรทัดต้องไม่ขึ้นต้นด้วย@เครื่องหมาย:

/**
 * Example usage:
 *
 * <pre>{@code  @Override
 * public int someMethod() {
 *     return 13 + 37;
 * }
 * }</pre>
 */

โปรดทราบว่ามีช่องว่างสองช่องระหว่าง@codeและ@Overrideเพื่อให้สิ่งต่าง ๆ สอดคล้องกับบรรทัดถัดไป ในกรณีของฉัน (ใช้ Apache Netbeans) มันแสดงผลอย่างถูกต้อง

มีความแตกต่างอย่างมีนัยสำคัญระหว่าง<blockquote><pre>...และ<pre>{@code....อดีตจะละเว้นการประกาศประเภทใน generics แต่หลังจะเก็บไว้

E.g.: List<MyClass> myObject = null; แสดงเช่นเดียวList myObject = null;กับ firts และเช่นเดียวList<MyClass> myObject = null;กับที่สอง

หากคุณเป็นนักพัฒนา Android คุณสามารถใช้:

<pre class=”prettyprint”>

TODO:your code.

</pre>

หากต้องการพิมพ์โค้ดของคุณใน Javadoc ด้วยโค้ด Java

ลองแทนที่ "code" ด้วย "pre" แท็กล่วงหน้าใน HTML ทำเครื่องหมายข้อความว่ามีการจัดรูปแบบไว้ล่วงหน้าและ linefeeds และช่องว่างทั้งหมดจะปรากฏตรงตามที่คุณพิมพ์

ฉันเพิ่งอ่าน Javadoc 1.5 การอ้างอิงที่นี่และมีเพียงรหัสที่มี<และต้องอยู่ภายใน> {@code ...}นี่เป็นตัวอย่างง่ายๆ:

 /** 
 * Bla bla bla, for example:
 *
 * <pre>
 * void X() {
 *    List{@code <String>} a = ...;
 *    ...
 * }
 * </pre>
 *
 * @param ...
 * @return ...
 */
 .... your code then goes here ...

ฉันใส่โค้ดตัวอย่างของฉันด้วย<pre class="brush: java"></pre>แท็กและใช้SyntaxHighlighterเพื่อเผยแพร่ javadocs ไม่ทำให้ IDE เสียหายและทำให้โค้ดตัวอย่างที่เผยแพร่ออกมาสวยงาม

การใช้ Java SE 1.6 ดูเหมือนว่าตัวระบุ UPPERCASE PRE ทั้งหมดเป็นวิธีที่ดีที่สุดใน Javadoc:

/**
 * <PRE>
 * insert code as you would anywhere else
 * </PRE>
 */

เป็นวิธีที่ง่ายที่สุดในการทำเช่นนี้

ตัวอย่างจาก javadoc ฉันได้จากวิธี java.awt.Event:

/**
 * <PRE>
 *    int onmask = SHIFT_DOWN_MASK | BUTTON1_DOWN_MASK;
 *    int offmask = CTRL_DOWN_MASK;
 *    if ((event.getModifiersEx() & (onmask | offmask)) == onmask) {
 *        ...
 *    }
 * </PRE>
 */

สิ่งนี้สร้างผลลัพธ์ที่ดูเหมือนรหัสปกติโดยมีการเว้นว่างโค้ดปกติและบรรทัดใหม่ที่ไม่เปลี่ยนแปลง

ใน Visual Studio Code อย่างน้อยคุณสามารถบังคับให้คอมเม้นท์ Javadoc เคารพการขึ้นบรรทัดใหม่โดยการตัดมันในทริบแบ็คสามครั้งดังที่แสดงด้านล่าง:

/** ```markdown
 * This content is rendered in (partial) markdown.
 * 
 * For example, *italic* and **bold** text works, but [links](https://www.google.com) do not.
 * Bonus: it keeps single line-breaks, as seen between this line and the previous.
 ``` */