J'ai un petit exemple de code que je veux inclure dans le commentaire Javadoc pour une méthode.
/**
* -- 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
*/
Le problème est que l'exemple de code apparaît dans le Javadoc sans saut de ligne, ce qui le rend difficile à lire.
-- 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
Je suppose que je me trompe en supposant que la balise de code gérerait les sauts de ligne. Quelle est la meilleure façon de formater des exemples de code dans les commentaires Javadoc?