web-dev-qa-db-fra.com

IDE mots-clés de commentaire

Je n'ai donc découvert que récemment le commentaire TODO. Pour ceux d'entre vous qui ne le savent pas, la plupart des IDE modernes reconnaîtront ce mot dans un commentaire et marqueront la ligne de commentaire d'une couleur différente pour qu'elle se démarque.

PAR EXEMPLE.

//Need to talk to Bill about refactoring this code

//TODO:Need to talk to Bill about refactoring this code

Vous pouvez remarquer dans les IDE comme Eclipse ou Rubymine mettez en surbrillance le commentaire TODO et quelques autres fonctionnalités intéressantes à faire avec.

Ma question est: Quels sont les autres mots clés comme TODO? Cela semble être une bien meilleure façon de communiquer aux développeurs via des commentaires et une fonctionnalité qui devrait être un peu plus connue dans les IDE. Leur but est d'aider au développement après tout.

eclipseidecommentsrubyminetodo
42
OVERTONE

Je peux parler d'Eclipse, vous pouvez le personnaliser.

Cliquez sur Fenêtre -> Préférences, et recherchez Général -> Éditeurs -> Éditeurs de texte structuré -> Balises de tâche, ou Java -> Compilateur -> Balises de tâche (il peut y en avoir d'autres comme JavaScript, PHP, StatET, etc.)

TODO, FIXME, XXX

J'en utilise des supplémentaires comme:

CHECKME, DOCME, TESTME, PENDING

Personnellement, j'aime utiliser les balises DISCUSS/REVIEW juste pour m'assurer de parler d'un problème avec quelqu'un lors d'une révision de code ou d'une programmation par paire (par exemple, je n'ai pas mal compris la spécification de la façon dont quelque chose devrait fonctionner, etc.).

Vous pouvez également définir les priorités attribués aux différentes balises de tâche là aussi.

61
rlegendi

Ceux-ci sont connus sous le nom de task tags. Dans Eclipse, ce sont TODO, FIXME et XXX.

Cependant, Eclipse vous permet de modifier la liste disponible des balises de tâche. Accédez à preferences> Java> Compiler> Task Tags

Ici, vous pouvez modifier la liste des balises de tâche disponibles, changer leur priorité et décider si les balises de tâche doivent être sensibles à la casse ou non.

10
helloworld922

Pour ajouter des balises TODO personnalisées dans IntelliJ allez à:

Préférences> Editeur> TODO

2
John R Perry

pour activer/désactiver le formateur de code, utilisez: // @formatter: on // @formatter: off

1
noname noname

Dans Eclipse Oxygen 4.7.2 pour C/C++, les balises de tâche sont configurées dans Windows -> Préférences -> C/C++ -> Balises de tâche.

Vous pouvez également activer la recherche de balises de tâche comme réponse @rlegendi.

1
Rodrigo

Les modèles comme TODO, FIXME sont par défaut dans NetBeans comme mots-clés ToDo. Vous pouvez également ajouter n'importe quel mot-clé de votre choix dans Outils> Options> Divers> Tâches.

1
user1242756