2012-03-06 2 views
31

J'ai donc récemment découvert le commentaire TODO. Pour ceux d'entre vous qui ne le savent pas, la plupart des IDE reconnaîtront ce mot dans un commentaire et marqueront la ligne de commentaire d'une couleur différente.IDE comment Mots-clés

EG.

//Need to talk to Bill about refactoring this code 

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

Vous remarquerez peut-être dans IDE comme Eclipse ou Rubymine mettent en lumière le commentaire TODO et quelques belles autres caractéristiques à faire avec elle.

Ma question est: Quels autres mots-clés y a-t-il comme le TODO? Cela semble être une meilleure façon de communiquer avec les développeurs grâce à des commentaires et une fonctionnalité qui devrait être un peu plus largement connue dans les IDE. Leur but est d'aider au développement après tout.

+3

'FIXME:' fonctionne de manière similaire à 'TODO:' dans vim. Pas tout à fait un IDE, mais quand même ... :) – cHao

+1

Peut confirmer que FIXME fonctionne aussi en eclipse. Ça sonne bien en fait. Thats 2: D – OVERTONE

+1

Juste une petite note: laissez le ':' à la fin des balises de tâche. Beaucoup d'outils les ajoutent après la définition qui est une sorte de bruit par la suite (en particulier si certains développeurs l'utilisent, certains pas, par exemple, il dérange un peu le * Tâches Voir * dans les anciennes versions Eclipse). – rlegendi

Répondre

52

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

Cliquez sur Fenêtre -> Préférences et recherchez Général -> Editeurs -> Editeurs de texte structurés -> balises de tâches, ou pour Java -> Compiler -> Tags de la tâche (il pourrait y avoir plus ceux comme pour JavaScript, PHP, StatET, etc.)

TODO, FIXME, XXX 

J'utilise quelques autres comme ceux:

CHECKME, DOCME, TESTME, PENDING 

personnellement, je aime u Suis les balises DISCUSS/REVIEW juste pour m'assurer que je parle d'un problème avec quelqu'un pendant une révision de code ou une programmation en paire (par exemple, je n'ai pas mal compris la spécification de comment quelque chose devrait fonctionner, etc.).

Vous pouvez également définir ici les priorités affectées aux différentes variables de tâche.

+1

J'ai ajouté ASSUMES pour capturer des conditions préalables non-évidentes. – rimsky

8

Ceux-ci sont connus comme task tags. Dans Eclipse, ils sont TODO, FIXME et XXX. Toutefois, Eclipse vous permet de modifier la liste des balises de tâche disponibles. Aller à preferences>Java>Compiler>Task Tags

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

1

Les modèles comme TODO, FIXME sont par défaut dans NetBeans en tant que mots-clés ToDo. Vous pouvez également ajouter un mot-clé dans Outils> Options> Divers> Tâches.

+0

Je suis conscient de cela. J'étais juste à la recherche d'une liste de ceux généralement acceptés ou par défaut dans l'indstry – OVERTONE

1

pour activer/désactiver l'utilisation de formatter code: // @formatter: sur // @formatter: off

0

Pour ajouter des tags TODO personnalisés dans IntelliJ aller à:

Préférences> Editeur > TODO

1

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

Vous pouvez également activer la recherche d'étiquettes de tâche en tant que réponse @rlegendi.