Pourquoi tout le monde écrit-il des choses à faire en majuscules? [fermé]
9
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?
Parce que nous LE SENSONS vraiment (nous n'y arrivons jamais)
Anthony Pegram
3
afin que les éditeurs puissent les marquer et vous permettre de les parcourir (liste des tâches d'Eclipse par exemple)
Ratchet Freak
6
Comme vous ne pouviez pas réellement mettre du texte en gras dans le code, vous aviez besoin d'un moyen de faire ressortir les choses importantes. Par conséquent ...
Karlson
4
En quoi est-ce important?
Tour
3
J'écris//todo:...
BЈовић
Réponses:
23
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.
Il permet également aux éditeurs de le souligner. gedit le fait, par exemple, et il ne le fait que pour tous les majuscules TODO. Quelle que soit la raison, c'est assez incitatif pour moi de l'écrire en majuscules.
4
@delnan: C'est une tautologie. Il a été fait pour se démarquer, donc les gens l'ont utilisé, donc quelqu'un a ajouté la coloration syntaxique dans vim pour se démarquer davantage, afin que les gens l'utilisent pour se démarquer. Les gens ne l'utilisent pas parce que l'éditeur le fait ressortir, ils l'utilisent parce qu'il est courant de le faire et donc l'éditeur le fait ressortir. Vous pouvez faire ressortir n'importe quoi dans vim, il suffit de changer la syntaxe en le mettant en évidence de manière appropriée, il est tout aussi facile de le faire todoressortir, mais cela ne sert à rien car la convention consiste à utiliser TODO.
Martin York,
1
@LokiAstari: Comme je l'ai dit, je l'ai épelé en majuscules car plus d'éditeurs le mettent en évidence par défaut. Mais je suis peut-être une exception: assez jeune (donc je n'aurais pas pu le faire avant que les éditeurs ne le soutiennent) et (malheureusement) trop de pleurnichard et de fainéant pour régler manuellement la coloration syntaxique.
Aussi bien pour le pauvre gars qui a besoin de nettoyer après vous, et pour tous ceux qui ont besoin de regarder votre code avant qu'il ne soit terminé. Ils peuvent voir d'un coup d'œil ce qui n'a pas encore été fait à cause de cette convention.
sq33G
2
J'ai rencontré TODO à casse mixte dans un nom de variable comme filesToDownload. Bien sûr, la recherche «mots entiers uniquement» résout ce problème.
dan04
8
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.
Visual Studio a commencé à faire les commentaires // TODO: lorsqu'il a ajouté pour la première fois les générateurs de code pour les éléments passe-partout MFC. C'était la version 2.0, iirc.
mjfgates
au moins pour Visual studio, cette recherche n'est pas sensible à la casse - elle tirera // todo foo dans la liste des tâches aussi
jk.
4
Je me démarque juste et est facile à attraper ... rien de compliqué!
cela et son facile à trouver via grep ou similaire
Zachary K
@ZacharyK: Exactement!
Dynamic
1
Il attire l'attention sur le fait qu'il existe une tâche.
Il est important qu'il soit évident tout le temps que quelqu'un doit revenir au code. Les détails doivent seulement être connus de la personne qui revient pour aborder le problème.
D'autres éditeurs ont des fonctionnalités de recherche et vous pouvez tout aussi facilement rechercher des tâches .
Karlson
Sauf que 'todo' peut apparaître dans quelque chose d'autre comme un nom de variable ou un autre texte de commentaire ...
sevenseacat
1
vi est sensible à la casse. Étant donné que les majuscules sont utilisées avec parcimonie dans la plupart des langues modernes (dans des choses comme les constantes nommées), la recherche a une forte probabilité de réussite.
ncmathsadist
1
Certains éditeurs ne mettent en évidence que les éléments TODO en majuscules, il est donc plus sûr de toujours utiliser des majuscules.
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é.
//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.
la source
TODO. Quelle que soit la raison, c'est assez incitatif pour moi de l'écrire en majuscules.todoressortir, 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.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.
la source
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.
la source
Je me démarque juste et est facile à attraper ... rien de compliqué!
la source
Il attire l'attention sur le fait qu'il existe une tâche.
Il est important qu'il soit évident tout le temps que quelqu'un doit revenir au code. Les détails doivent seulement être connus de la personne qui revient pour aborder le problème.
la source
Si vous êtes un utilisateur vi, utilisez:
Cela vous y mènera très rapidement.
la source
Certains éditeurs ne mettent en évidence que les éléments TODO en majuscules, il est donc plus sûr de toujours utiliser des majuscules.
la source
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é.
la source