Rendre le formateur de code Java d'Eclipse ignorer les commentaires de bloc
Existe-t-il un moyen de faire en sorte que le formateur de code Java intégré d'Eclipse ignore les commentaires? A chaque fois que je le lance, ça change:
/*
* 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 Windows> Préférences> Java> Code Style> Formatter, mais je ne peux pas en trouver un pour conserver le format de commentaire. J'utilise Eclipse 3.4.0.
Mise à jour 2010, comme indiqué par l'OP _ et dans cette réponse , la chaîne spéciale // @formatter:off dans Eclipse 3.6 suffit.
_ { 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 "Javadoc comment settings", de décocher "Format HTML tags".
Vérifiez également le "Never join lines" dans la section "General settings".
Ensuite, 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 commentaire Javadoc, et pas un commentaire simple, car je pense qu'un commentaire contenant autant de texte peut être mieux placé devant une méthode. De plus, les sections Javadoc ont plus de paramètres de formatage à jouer.
Si elle est devant une méthode (vrai Javadoc), les balises HTML <dl>, <dt> et <dd> 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 la mise en forme Ne sera pas affectée si vous formatez le reste du fichier.
/* - * Voici un commentaire de bloc avec des informations très spéciales * le formatage que je veux indent (1) ignorer . * * un * deux * Trois */
Source: http://www.Oracle.com/technetwork/Java/javase/documentation/codeconventions-141999.html#350
Je viens d'apprendre d'un collègue qu'Eclipse offre des balises de formatage spéciales pouvant ê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é via le menu Préférences → Java> Style de code> Formateur, en cliquant sur Modifier, en sélectionnant l'onglet Désactiver/Activer et en cochant Activer les balises Dés/Act ( la source ).
Un rapide Google pour la chaîne @formatter: off m'a amené à cette autre SO réponse , qui a mentionné cette fonctionnalité dans le contexte de la désactivation du formateur pour les blocs de code. J'ai confirmé que cela fonctionne pour les commentaires de ligne, les commentaires de bloc "normaux" et les commentaires de bloc Javadoc.
Une autre possibilité consiste à utiliser le fichier <pre> de HTML dans Javadoc:
/**
* <pre>
* this
* is
* kept
* as
* is
* </pre>
*/
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 les balises <pre> </pre>.
Dans Eclipse 3.4: Préférences, Java-> Code Style-> Formatter, puis modifiez profil, onglet commentaires. Il y a un tas d'options pour contrôler le formatage des commentaires.
une solution consiste à ajouter pre tag pour les commentaires que vous ne souhaitez pas que Eclipse mette en forme.
/**
* <pre>
* this part
* is
* out of
* format
*
* </pre>
*/
Si vous souhaitez supprimer le formatage dans Eclipse, vous pouvez toujours envelopper le contenu destiné à ne pas être formaté dans la balise <pre>UNFORMATTED CONTENT</pre>. Javadoc formateur détectera cette balise et laissera tout ce qui est entre ces balises non formaté.
Avantages:
- Le reste de Javadoc est toujours formaté
- La sortie HTML de Javadoc sera "non formatée" aussi à cause des balises pré
Les inconvénients:
- Ne pas en voir un
Vous pouvez modifier cela Windows - Préférences - Java - Code Style - Formateur, Cliquez ensuite sur le bouton Modifier .., recherchez Commentaires, Choisissez les lignes Ne jamais joindre.
Alors, ça devrait aller.
Cela dépend de la langue.
Par exemple, si vous utilisez JavaScript, accédez à "Fenêtre -> Préférences -> Javascript -> Code Style -> Formatter", puis modifiez les options de formatage.
Éditer (reflétant les changements dans les questions OP
Pour modifier le formatage du code Java, accédez à "Fenêtre -> Préférences -> Java -> Style de code -> Formateur"
En haut du panneau, vous verrez
Profil actif:
Eclipse [intégré]
À partir de là, vous avez un bouton à droite, "Modifier", et deux autres "Nouveau ..." et "Importer ..." ... ci-dessous. Je vous recommande de modifier le profil existant.
Dans la boîte de dialogue d'édition du profil, une série d'onglets se trouvent en haut. Le dernier onglet est "Commentaires". Pour désactiver complètement le formatage des commentaires, décochez les cases "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".
Essaye celui-là. Cela a fonctionné pour moi. Avec le Java Formateur (Windows> Préférences> Java> Style Style> Formateur), vous pouvez créer un nouveau profil de formateur à partir d'un existant, puis le modifier.
Si Eclipse n'autorise pas l'enregistrement, créez-en un nouveau et enregistrez-le. 