web-dev-qa-db-fra.com

Comment gérer des trucs de programmation @Todo?

Pendant de nombreuses années, mon code était plein de ce genre de commentaires:

//TODO : Add ...
...
/*
 *TODO : Fix ...
 *
 */

Maintenant, je pense créer mon propre @todo Annotation Javadoc ... Mais avant de le faire, je veux savoir si vous avez un meilleur moyen de gérer votre TODO Programmation?

javajavadocproject-management
23
wj.

Votre IDE (Eclipse, NetBeans, ..) a un plugin de tâches qui détecte tous les TODOs et les montre dans une liste. Dans Eclipse c'est Window > Show View > Other > Tasks

Pas besoin d'écrire votre propre annotation.

48
Bozho

Les déclarations de TODO portent le risque d'être laissé dans le code pour toujours, ce qui est mauvais parce que // TODO elaborate answer

35
Daniel Daranas

J'utilise essentiellement trois systèmes pour différents types d'articles de TODO:

  • Bloc-notes en papier pour les articles à court terme (comme aujourd'hui ou cette semaine)
  • TODO COMMENTAIRES PLUS IDE (E.G. Tâches Eclipse View) pour des éléments plus petits et à long terme
  • Suivez le tracker comme Trac Plus IDE Support (E.G MYLYN) pour des éléments plus complexes, à long terme
12
Fabian Steeg

Pour Vim, il y a aussi ceci TaskList Script, inspiré de la liste des tâches de Eclipse, qui érame le TODO, FIXME, etc. dans vos fichiers texte et les affiche comme une liste dans un tampon supplémentaire (voir Capture d'écran ).

5
catchmeifyoutry

Je n'utiliserais pas de @todo Annotation Javadoc Parce que l'OMI ne devrait pas entrer dans la documentation.
La documentation devrait être publique, pas idéale pour les Todos.
[.____] Les Todos devraient également aller près du code qu'ils concernent, un avantage d'utiliser des commentaires.

4
user85421

Pour les petites tâches telles que mon habituel // TODO, j'utilise des tâches locales à Eclipse Mylyn, pour des tâches plus grandes (même si je pense que celles-ci pourraient être appelées fonctionnalités ou bugs), j'utilise TRAC; Si vous trouvez votre code plein de TODOS, il est temps d'obtenir un système de gestion de billets.

2
Alberto Zaccagni

Peut-être que vous pouvez utiliser Rechercher et Grep pour rechercher ces mots-clés de vos projets

2
ZelluX

J'utilise correctement! au lieu de TODO. Le nombre de points d'exclamation indique la priorité. Intellij vous permet de configurer des filtres personnalisés pour ceux-ci, afin que je puisse regarder le niveau-3 "solution !!!" commente et aborder ceux-ci.

2
Sam Barnum

Si vos déclarations de TODO vous dérangent beaucoup et vous causant beaucoup d'angoisse lorsque vous les voyez, j'écris un petit script dans le processus de construction qui détecte et échoue de la compilation. Avoir échoué de la même manière qu'il échoue sur des déclarations d'avertissement.

1
wheaties

TODO va bien dans une petite équipe, mais si vous êtes un projet open source ou élargissez l'accès au développeur de quelque manière que ce soit, les autres variantes telles que_do, Fixme, XXX, Note, Hack, Bug, "Your_defect_Tool_Here" et ainsi de suite à la numérisation de toute façon . Un peu de poids lourd, mais mon protocole de Todo ressemblerait à:

TODO: YY-MM-DD: Auteur: Votre mandat

Enfin, faites le commentaire que vous laissez la stratégie, pas une déclaration de conception ou une opinion.

0
Conrad B