Je fais pareil. Quand il y a quelque chose "à faire" dans mon code, j'écris //TODO ...
. Mais je suis curieux de savoir quand cela a commencé et s'il y a une raison d'écrire "à faire" en toutes lettres majuscules?
//todo:...
Je fais pareil. Quand il y a quelque chose "à faire" dans mon code, j'écris //TODO ...
. Mais je suis curieux de savoir quand cela a commencé et s'il y a une raison d'écrire "à faire" en toutes lettres majuscules?
//todo:...
Réponses:
De plus, c'est génial d'avoir un moyen de rechercher facilement les sections de code que vous avez masquées et que vous souhaitez revenir. Vous pouvez faire une recherche sensible à la casse pour "TODO" pour trouver immédiatement ce que vous avez ignoré auparavant.
"todo" (minuscule) pourrait potentiellement faire partie d'un mot / fonction / variable plus large, mais "TODO" (majuscule) ne le sera probablement pas.
TODO
. Quelle que soit la raison, c'est assez incitatif pour moi de l'écrire en majuscules.
todo
ressortir, mais cela ne sert à rien car la convention consiste à utiliser TODO.
filesToDownload
. Bien sûr, la recherche «mots entiers uniquement» résout ce problème.
Je suis curieux de savoir quand cela a commencé et s'il y a une raison d'écrire à faire tous les capitaux?
L'idée avec des commentaires comme TODO et FIXME est de les faire ressortir. En général, vous ne voulez pas expédier de code contenant de tels marqueurs dans le code - ils marquent les choses à faire avant que le projet puisse être considéré comme terminé. L'utilisation de TOUTES MAJUSCULES les rend un peu plus faciles à repérer, à condition de ne pas utiliser TOUTES MAJUSCULES pour beaucoup d'autres choses dans votre code.
Eclipse et Visual Studio ont tous deux des fonctionnalités de liste des tâches qui vous fournissent automatiquement des listes de lignes de commentaires contenant TODO.
Si vous êtes un utilisateur vi, utilisez:
/FAIRE
Cela vous y mènera très rapidement.
Visuellement, TOUS LES CAPS se distinguent, mais ne sont pas très lisibles. Lors de la lecture du code, ils scannent comme un bloc d'une taille particulière. Peu importe ce que sont les lettres. Ils se démarquent et peuvent être vus très rapidement. Une fois que vous travaillez avec les balises depuis un certain temps, votre cerveau reconnaît le mot par sa forme.
Du point de vue des outils (IDE / Editor), la recherche sensible à la casse aura un taux de faux positifs très bas sur toutes les versions de majuscules. Dans certains styles de codage, il existe un faible risque qu'une correspondance soit établie. La recherche de mots entiers sensible à la casse rend les faux positifs encore moins probables.
Une fois que l'outil l'affiche à l'écran, le format indique clairement regardez ICI. Une fois que vous êtes concentré sur l'emplacement, la partie lisible sera le commentaire associé.