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

Update 2010, comme indiqué par l’OP et dans cette réponse , la chaîne spéciale // @formatter:off dans Eclipse 3.6 est suffisante.

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

Dans l’onglet Commentaires (dans eclipse3.5), vous pouvez vous assurer, dans les ” Javadoc comment settings “, de désélectionner ” Format HTML tags “.
Cochez également la Never join lines ” Never join lines ” dans la section ” General settings “.

Ensuite, votre commentaire devrait être écrit comme suit:

 /** * PSEUDOCODE * Read in user's ssortingng/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 */ 

Note: J’ai fait un commentaire sur Javadoc , et non un simple commentaire, car je pense qu’un commentaire avec autant de texte peut être mieux placé devant une méthode. De plus, les sections Javadoc ont plus de parameters de formatage avec lesquels jouer.
Si elle se trouve devant une méthode (vrai Javadoc), les balises HTML

,

et

aideront à la présenter correctement dans la vue Javadoc.

Il existe une autre solution que vous pouvez utiliser pour supprimer la mise en forme de commentaires de bloc spécifiques. Utilisez /*- (notez le trait d’union) au début du commentaire de bloc, et le formatage ne sera pas affecté si vous formatez le rest du fichier.

 / * -
  * Voici un commentaire de bloc avec quelques très spéciaux
  * le formatage que je souhaite ignorer (1).
  *
  * un
  * deux
  * Trois
  * /

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

Je viens d’apprendre par un collègue qu’Eclipse propose des balises de formatage spéciales qui peuvent être utilisées pour cela:

 // @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é via le menu Préférences → Java> Style de code> Formateur, en cliquant sur Modifier , en sélectionnant l’onglet Désactiver / Activer les balises et en cochant Activer les balises Désactiver / Activer ( source ).

Un rapide Google pour la chaîne @formatter: off m’a amené à cette autre réponse 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.

Une autre possibilité est d’utiliser

 HTML dans Javadoc: 

 /** * 
 * this * is * kept * as * is * 
 */ 
  Au moins, c'est comme ça que j'ai tendance à intégrer mon art ASCII dans les commentaires de code source 🙂 

Entourez le texte spécifique avec

balises

.

Dans Eclipse 3.4: Préférences, Java-> Style de code-> Formateur, puis modifiez le profil, l’onglet Commentaires. Il y a un tas d’options pour contrôler le format des commentaires.

Si vous souhaitez supprimer le formatage dans eclipse, vous pouvez toujours envelopper le contenu destiné à NE PAS ÊTRE FORMATÉ dans la

UNFORMATTED CONTENT

. Javadoc Formatter détectera cette balise et laissera tout ce qui se trouve entre ces balises non formaté.

Avantages:

• Le rest de Javadoc est toujours formaté
• La sortie HTML de Javadoc sera “non formatée” à cause des balises pre

Les inconvénients:

• Ne pas en voir un

C’est dépendant de la langue.

Par exemple, si vous travaillez avec javascript, accédez à “Fenêtre -> Préférences -> Javascript -> Style de code -> Formateur”, puis modifiez les options du formateur.

Edit (reflétant les modifications dans les questions OP

Pour éditer le formatage du code Java, allez dans “Fenêtre -> Préférences -> Java -> Style de code -> Formateur”

En haut du panneau, vous verrez

Profil actif:
Eclipse [intégré]

De là, vous avez un bouton à droite, “Modifier”, et deux ci-dessous, “Nouveau …” et “Importer …”. Je recommande de modifier le profil existant.

Dans la boîte de dialog d’édition du profil, une série d’tabs se trouvent en haut. Le dernier onglet est “Commentaires”. Pour désactiver complètement le formatage des commentaires, décochez la case “Activer le formatage des commentaires Javadoc”, “Activer le formatage des commentaires de bloc”, “Activer le formatage des commentaires de ligne” et “Activer le formatage des commentaires d’en-tête”.

une solution consiste à append une balise pre pour les commentaires que vous ne souhaitez pas que eclipse formate

 /** * 
 * this part * is * out of * format * * 
 */