Javadoc 주석의 여러 줄 코드 예제

질문 : 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 태그 에서 찾을 수 있습니다.)

출처 : https://stackoverflow.com/questions/541920/multiple-line-code-example-in-javadoc-comment