Ich habe ein kleines Codebeispiel, das ich in den Javadoc-Kommentar für eine Methode aufnehmen möchte.
/**
* -- 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
*/
Das Problem ist, dass der Beispielcode in der Javadoc ohne Zeilenumbrüche angezeigt wird, was das Lesen erschwert.
-- 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
Ich schätze, dass ich falsch liege, wenn ich annehme, dass das Code-Tag Zeilenumbrüche verarbeiten würde. Wie lassen sich Codebeispiele in Javadoc-Kommentaren am besten formatieren?