Rendre le formateur de code Java d'Eclipse ignorer les commentaires de bloc
https://stackoverflow.com/questions/1024886
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
RussianQuestion
Existe-t-il un moyen de faire en sorte que le formateur de code Java intégré d'Eclipse ignore les commentaires? Chaque fois que je le lance, il se présente comme suit:
/*
* 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 Windows > Préférences & Gt; Java & Gt; Style de code & Gt; Paramètres de formateur, mais vous ne pouvez pas en trouver un pour conserver la mise en forme des commentaires. J'utilise Eclipse 3.4.0.
La solution
Mise à jour 2010, en tant que pointé 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 Java Formatter ( Windows > Préférences > Java > Code Style > Formatter ), vous pouvez créer un nouveau profil Formatter.
Dans l'onglet Commentaires (dans eclipse3.5), vous pouvez vous assurer que, dans les " paramètres de commentaire Javadoc ", décochez la case " Balises HTML de format ". ".
Vérifiez également le lien " Ne jamais joindre les lignes ". dans le " Paramètres généraux " section.
Ensuite, votre commentaire doit être rédigé 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
*/
Remarque: j'ai fait un commentaire Javadoc , et non 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 pour jouer.
Si elle se trouve devant une méthode (vrai Javadoc), les balises HTML < dl > ; , < dt > et < dd > vous aideront à le présenter correctement dans la vue Javadoc.
Autres conseils
Il existe une autre solution que vous pouvez utiliser pour supprimer le formatage 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é 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 */
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 & # 8594; Java > Style de code > Cliquez sur Modifier , sélectionnez l'onglet Balises désactivées / activées , puis cochez la case Activer les balises désactivées (source ).
Un rapide Google pour la chaîne @formatter: off m'a amené à cette autre réponse SO , qui a mentionné cette fonctionnalité dans le contexte de la désactivation du formateur pour les blocs de code. J'ai confirmé que cela fonctionnait pour les commentaires de ligne, "normal" et "normal". bloquer les commentaires et Javadoc bloquer les commentaires également.
Une autre possibilité consiste à utiliser les balises HTML < pre > dans Javadoc:
/**
* <pre>
* this
* is
* kept
* as
* is
* </pre>
*/
Au moins, voici comment j'ai tendance à intégrer mon art ASCII dans les commentaires de code source:)
Entourez le texte spécifique avec < pre > Balises < / pre > .
Dans Eclipse 3.4: Préférences, Java- > Code Style- > Formatter, puis modifiez profil, onglet commentaires. Il existe de nombreuses options pour contrôler le formatage des commentaires.
Si vous souhaitez supprimer le formatage dans eclipse, vous pouvez toujours envelopper le contenu destiné à ne PAS formater dans la balise < pre > UNFORMATTED CONTENT < / pre > . Le formateur Javadoc détectera cette balise et laissera tout ce qui se trouve 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é
Inconvénients:
- Ne pas en voir un
L’une des solutions consiste à ajouter une balise pre pour les commentaires que vous ne souhaitez pas que eclipse soit mis en forme
./**
* <pre>
* this part
* is
* out of
* format
*
* </pre>
*/
Cela dépend de la langue.
Par exemple, si vous utilisez JavaScript, accédez à la fenêtre " Fenêtre - > Préférences - > Javascript - > Style de code - > Formateur " puis éditez les options du formateur.
Modifier (reflétant les modifications apportées aux 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 ci-dessous, "Nouveau ...". et "Importer ...". 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 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".
Vous pouvez changer cela en Windows - Préférences - Java - Style de code - Formateur, cliquez sur le bouton Modifier .., recherchez Commentaires, choisissez les lignes Ne jamais joindre.
Ensuite, ça devrait aller.
Essayez celui-ci. Cela a fonctionné pour moi. Avec Java Formatter (Windows > Préférences > Java > Code Style > Formatter), vous pouvez créer un nouveau profil Formatter à partir d'un existant, puis le modifier.
Si Eclipse ne permet pas de sauvegarder ceci, créez-en un nouveau et sauvegardez-le.
