Faire du formateurcode Java d'Eclipse ignorer les commentaires de bloc
y a-t-il un moyen de faire ignorer les commentaires par le formatteur de code Java intégré à Eclipse? Chaque fois que je l'exécute, il tourne 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 Windows > Preferences > Java > Code Style > Formatter, mais je ne peux pas en trouver un pour conserver le formatage des commentaires. J'utilise Eclipse 3.4.0.
9 réponses
mise à Jour de 2010, que soulignée par l'OP et dans cette réponse , la chaîne de caractères spéciaux // @formatter:off dans Eclipse 3.6 est assez.
Il n'était pas disponible au moment de la question.
réponse Originale à cette question: en juin 2009, Eclipse 3.4/3.5
avec le Formatteur 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 ".
Cochez également la case" Never join lines "dans la section" General settings ".
alors votre commentaire doit être écrit comme:
/**
* 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 commentaire, et pas un simple commentaire, comme je crois un commentaire avec que beaucoup de texte, il peut être mieux placé en face d'une méthode. De plus, les sections Javadoc ont plus de paramètres de formatage pour jouer.
S'il est en face d'une méthode (vrai Javadoc), les HTML tags <dl> , <dt> et <dd> aideront à le présenter correctement dans la vue Javadoc.
il y a une autre solution que vous pouvez utiliser pour supprimer le formatage des 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ée 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
je viens d'apprendre d'un collègue Qu'Eclipse offre des étiquettes de formatage spéciales qui peuvent être utilisées pour ceci:
// @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 pourriez avoir besoin d'activer manuellement cette fonctionnalité à travers le menu Préférences → Java > Code Style > formater, en cliquant sur Edit , en sélectionnant Off/On Tags tab et en cochant Enable Off/On tags ( source ).
Un rapide Google pour la chaîne de caractères @formatter: off m'a amené à cette autre réponse , qui mentionnait cette fonctionnalité dans le contexte de la désactivation du formatteur pour les blocs de code. J'ai confirmé que cela fonctionne aussi pour les commentaires de ligne, les commentaires de bloc "normaux" et les commentaires de bloc Javadoc.
une autre possibilité est d'utiliser le
de HTML dans Javadoc:/** * <pre> * this * is * kept * as * is * </pre> */du moins, c'est ainsi que j'ai tendance à intégrer mon ASCII-art dans les commentaires du code source:)
entourent le texte spécifique avec des étiquettes <pre> </pre> .
Dans Eclipse 3.4: Préférences, Java->Style de Code->Formatage, puis modifier le profil, onglet commentaires. Il y a un tas d'options pour contrôler le formatage des commentaires.
si vous voulez supprimer le formatage dans eclipse, vous pouvez toujours envelopper le contenu qui est destiné à ne pas être formaté dans <pre>UNFORMATTED CONTENT</pre> étiquette. format Javadoc détectera cette étiquette , et tout laisser entre ces étiquettes non formatée.
Pour:
- le reste de Javadoc est toujours formaté
- la sortie html de Javadoc sera "non formatée" aussi bien à cause des pré tags
Inconvénients:
- ne Pas voir un
cela dépend de la langue.
par exemple, si vous travaillez avec javascript, vous allez dans" Window -> Preferences -> Javascript -> Code Style -> Formatter " et puis modifiez les options formatter.
Modifier (reflétant les changementsdans OP Questions
pour éditer le formatage du code java, allez à "Window -> Preferences -> Java -> Style De Code -> Formateur"
En haut du panneau vous verrez
Profil Actif:
Eclipse [incorporé]
de là, vous avez un bouton à droite," Modifier", et deux ci-dessous, " Nouveau..."et "Importation...". Je recommande D'éditer le profil existant.
dans la boîte de dialogue Modifier le profil, il y a une série d'onglets en haut. Le dernier onglet "Commentaires". Pour désactiver complètement le formatage des commentaires, décocher "activer Javadoc commentaire mise en forme", "Activer le bloc de commentaire mise en forme", "Activer les commentaires de fin de ligne mise en forme", et "Activer le commentaire d'en-tête de"mise en page.
une solution est d'ajouter pre étiquette pour les commentaires que vous ne voulez pas éclipse au format
/**
* <pre>
* this part
* is
* out of
* format
*
* </pre>
*/