Faire en sorte que le formateur de code Java d'Eclipse ignore les commentaires de bloc

Question

Existe-t-il un moyen de faire en sorte que le formateur de code Java intégré à Eclipse ignore les commentaires ? Chaque fois que je l'exécute, il se transforme en ceci :

    /*
     * PSEUDOCODE
     * Read in user's string/paragraph
     * 
     * Three cases are possible
     * Case 1: foobar
     *         do case 1 things
     * Case 2: fred hacker
     *         do case 2 things
     * Case 3: cowboyneal
     *         do case 3 things
     *         
     * In all cases, do some other thing
     */

dans ceci :

    /*
     * PSEUDOCODE Read in user's string/paragraph
     * 
     * Three cases are possible Case 1: foobar do case 1 things Case 2: fred
     * hacker do case 2 things Case 3: cowboyneal do case 3 things
     * 
     * In all cases, do some other thing
     */

J'ai déjà joué avec les paramètres de Windows > Préférences > Java > Style de code > Formateur mais je n'en trouve pas un qui permette de conserver le formatage des commentaires. J'utilise Eclipse 3.4.0.

Answer 1

Il existe une autre solution que vous pouvez utiliser pour supprimer le formatage de certains commentaires de bloc. Utilisez /*- (notez le trait d'union) au début du commentaire du bloc, et le formatage ne sera pas affecté si vous formatez le reste du fichier.

/\*-
 \* Here is a block comment with some very special
 \* formatting that I want indent(1) to ignore.
 \*
 \*    one
 \*        two
 \*            three
 \*/

Source : http://www.oracle.com/technetwork/java/javase/documentation/codeconventions-141999.html#350

Answer 2

Mise à jour 2010, comme pointé par l'OP y dans cette réponse la chaîne spéciale // @formatter:off dans Eclipse 3.6 est suffisant.

Il n'était pas disponible au moment de la question.

---

Réponse originale : Juin 2009, Eclipse 3.4/3.5

Avec le formateur Java ( Windows > Preferences > Java > Code Style > Formatter ), vous pouvez créer un nouveau profil de formateur.

Dans l'onglet Commentaires (dans eclipse3.5), vous pouvez vous assurer, dans le champ " Javadoc comment settings ", pour décocher " Format HTML tags ".
Consultez également la rubrique " Never join lines " dans le " General settings section ".

Alors votre commentaire devrait être écrit comme suit :

/**
 * PSEUDOCODE
 * Read in user's string/paragraph
 * 
 * Three cases are possible:
 * <dl>
 *   <dt>Case 1: foobar</dt>
 *     <dd>        do case 1 things</dd>
 *   <dt>Case 2: fred hacker</dt>
 *     <dd>        do case 2 things</dd>
 *   <dt>Case 3: cowboyneal</dt>
 *     <dd>        do case 3 things</dd>
 * </dl>        
 * In all cases, do some other thing
 */

Note : J'ai fait un Javadoc et non un simple commentaire, car je pense qu'un commentaire contenant autant de texte serait mieux placé devant une méthode. De plus, les sections Javadoc ont plus de paramètres de formatage avec lesquels jouer.
S'il se trouve devant une méthode (véritable Javadoc), la balise Balises HTML <dl> , <dt> y <dd> aidera à le présenter correctement dans la vue Javadoc.

Answer 3

Un collègue vient de m'apprendre qu'Eclipse propose des balises de formatage spéciales qui peuvent être utilisées à cette fin :

// @formatter:off
/*
 * 
 *  Month   Sales  Position 
 * 
 *  June    44k    2nd      
 *  July    39k    2nd      
 *  August  49k    4th      
 * 
 *
 * This comment shouldn't be formatted, and will now be ignored by the formatter.
 */
// @formatter:on

Notez que vous devrez peut-être activer manuellement cette fonctionnalité par le biais du menu Préférences → Java > Style de code > Formateur, en cliquant sur le bouton Modifier en sélectionnant le Tags Off/On et en vérifiant Activation des balises Off/On ( source ).

Une recherche rapide sur Google pour la chaîne @formatter:off m'a amené à cette autre réponse de SO qui mentionnait cette fonctionnalité dans le contexte de la désactivation du formateur pour les blocs de code. J'ai confirmé que cela fonctionne également pour les commentaires de ligne, les commentaires de bloc "normaux" et les commentaires de bloc Javadoc.

Answer 4

Une autre possibilité est d'utiliser le <pre> de HTML dans Javadoc :

/**
 * <pre>
 *    this
 *   is
 *      kept
 *  as
 *    is
 * </pre>
 */

En tout cas, c'est ainsi que j'ai tendance à intégrer mon art ASCII dans les commentaires du code source :)

Answer 5

Entourez le texte spécifique avec <pre> </pre> tags.