Przykład kodu wielu linii w komentarzu Javadoc

Mam mały przykład kodu, który chcę uwzględnić w komentarzu Javadoc dla metody.

/**
 * -- 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
 */

Problem polega na tym, że przykład kodu pojawia się w Javadoc bez przerw w linii, co utrudnia czytanie.

-- 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 

Chyba się mylę, zakładając, że znacznik kodu poradzi sobie z łamaniem linii. Jaki jest najlepszy sposób formatowania przykładów kodu w komentarzach Javadoc?

Oprócz wspomnianych już <pre>znaczników, powinieneś również użyć @codeadnotacji JavaDoc, która znacznie ułatwi życie, jeśli chodzi o problemy z jednostkami HTML (w szczególności z Generics), np .:

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

Daje poprawny wynik HTML:

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

Pominięcie @codebloku (lub użycie <code>tagu) spowoduje HTML w następujący sposób:

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

(W celach informacyjnych opisy znaczników Java SE 8 można znaleźć tutaj: Tagi Javadoc )

Miałem naprawdę ciężki czas z umieszczeniem konkretnego przykładu kodu w komentarzu javadoc. Chciałbym się tym podzielić.
Uwaga:

• użycie old <code>- tag, aby zapobiec interpretacji nawiasów klamrowych
• użycie {@code ...}tagu „new”, aby uzyskać ogólne dane wyjściowe
• ucieczka znaku @ @Overrideza pomocą „ {@literal @}Override”, ponieważ generator javadoc „przechyla się” tam, ponieważ @ idzie bezpośrednio po nawiasach otwierających
• usuń jedną przestrzeń przed {@codei {@literal, aby skompensować wewnętrzne przestrzenie i zachować wyrównanie

kod 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
  */

zostanie wydrukowany jako

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

Źródło Java ma na to wiele dobrych przykładów. Oto przykład z nagłówka „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>
...

Dołącz swój kod wielowierszowy <pre></pre>tagami.

Potrzebne są <pre></pre>tagi do podziału linii, a {@code ... }wewnątrz - dla ogólnych. Ale wtedy nie wolno umieszczać otwierającego nawiasu w tym samym wierszu co <generic>znacznik, ponieważ wtedy wszystko będzie ponownie wyświetlane w 1 wierszu.

Wyświetla w jednym wierszu:

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

Wyświetla z podziałami linii:

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

Kolejną dziwną rzeczą jest to, że po wklejeniu klamry zamykającej {@codepojawia się:

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

Wynik:

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

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

• <pre/> jest wymagany do zachowania linii.
• {@code musi mieć własną linię
• <blockquote/> jest tylko dla wcięcia.

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

Minimalne wymagania dla odpowiednich kodów to <pre/>i {@code}.

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

daje

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

Opcjonalne otoczenie <blockquote/>wstawia wcięcie.

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

daje

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

Wstawienie <p>lub otoczenie <p>i </p>daje ostrzeżenia.

Byłem w stanie wygenerować dobrze wyglądające pliki HTML za pomocą następującego fragmentu kodu pokazanego w Kodzie 1.

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

(Kod 1)

Kod 1 zamienił się w wygenerowaną stronę HTML javadoc na ryc. 1, zgodnie z oczekiwaniami.

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

(Ryc. 1)

Jednak w NetBeans 7.2, jeśli naciśniesz Alt + Shift + F (aby ponownie sformatować bieżący plik), kod 1 zmienia się w kod 2.

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

(Kod 2)

gdzie pierwsza <pre>jest teraz podzielona na dwie linie. Kod 2 generuje wygenerowany plik HTML javadoc, jak pokazano na ryc. 2.

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

(Ryc. 2)

Sugestia Steve'a B (Kod 3) wydaje się dawać najlepsze wyniki i pozostaje sformatowana zgodnie z oczekiwaniami, nawet po wciśnięciu Alt + Shift + F.

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

(Kod 3)

Użycie kodu 3 daje takie same dane wyjściowe HTML javadoc, jak pokazano na ryc. 1.

Oto moje dwa centy.

Jak już wskazują inne odpowiedzi, powinieneś używać <pre> </pre>w połączeniu z {@code }.

Użyj prei{@code}

• Zawijanie kodu wewnątrz <pre>i </pre>zapobiega zwijaniu się kodu w jednym wierszu;
• Zawijania kodu wewnątrz {@code }zapobiega <, >i wszystko pomiędzy od znikają. Jest to szczególnie przydatne, gdy kod zawiera wyrażenia ogólne lub lambda.

Problemy z adnotacjami

Problemy mogą pojawić się, gdy blok kodu zawiera adnotację. Jest tak prawdopodobnie dlatego, że gdy @znak pojawia się na początku linii Javadoc, jest uważany za znacznik Javadoc, taki jak @paramlub @return. Na przykład ten kod może zostać niepoprawnie przeanalizowany:

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

Powyższy kod całkowicie zniknie w moim przypadku.

Aby to naprawić, linia nie może zaczynać się od @znaku:

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

Zauważ, że pomiędzy @codei są dwie spacje @Override, aby zachować wyrównanie do następnych linii. W moim przypadku (przy użyciu Apache Netbeans) jest renderowany poprawnie.

Istnieje znacząca różnica między <blockquote><pre>...i <pre>{@code....Pierwsza z nich pominie deklaracje typu w generycznych, ale druga zachowa ją.

E.g.: List<MyClass> myObject = null; wyświetla się jak w List myObject = null;przypadku pierwszego i List<MyClass> myObject = null;drugiego

Jeśli jesteś programistą Androida, możesz użyć:

<pre class=”prettyprint”>

TODO:your code.

</pre>

Aby całkiem wydrukować kod w Javadoc z kodem Java.

Spróbuj zamienić „kod” na „pre”. Wstępny znacznik w HTML oznacza tekst jako wstępnie sformatowany, a wszystkie linie i spacje będą wyświetlane dokładnie podczas ich wpisywania.

Właśnie przeczytałem tutaj odniesienie do Javadoc 1.5 i tylko kod z <i >musi być zawarty w środku {@code ...}. Oto prosty przykład:

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

Mój przykładowy kod załączam do <pre class="brush: java"></pre>tagów i używam SyntaxHighlighter do opublikowanych javadocs. Nie szkodzi to IDE i sprawia, że ​​opublikowane przykłady kodu są piękne.

Przy użyciu Java SE 1.6 wygląda na to, że wszystkie identyfikatory UPPERCASE PRE są najlepszym sposobem na zrobienie tego w Javadoc:

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

jest najprostszym sposobem na zrobienie tego.

Przykład z javadoc otrzymałem z metody java.awt.Event:

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

Daje to wynik, który wygląda dokładnie jak zwykły kod, z nienaruszonymi regularnymi odstępami kodów i nowymi wierszami.

Przynajmniej w programie Visual Studio Code możesz zmusić komentarz Javadoc do respektowania podziałów linii, zawijając go w potrójne odwrotne wstawki, jak pokazano poniżej:

/** ```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.
 ``` */