Questions marquées «comments»

Questions sur l'écriture de commentaires dans le code.

12
Les commentaires dépassés sont-ils un mythe urbain?
Je vois constamment des gens prétendre que "les commentaires ont tendance à devenir obsolètes". Le problème, c’est que j’ai peut-être vu deux ou trois commentaires obsolètes toute ma carrière. Les informations obsolètes contenues dans des documents distincts sont fréquentes, mais selon mon expérience, les commentaires obsolètes dans le code lui-même …
38 comments  myth 
13
Commentaire avant ou après le code correspondant [fermé]
En supposant qu'un commentaire ne va pas (ou ne peut pas aller) sur la ligne à laquelle il s'applique, faut-il écrire le commentaire avant ou après le code? Eh bien, là où les futurs lecteurs comprendront mieux la portée du commentaire. En d'autres termes, la plupart des programmeurs / scripteurs …
34 comments 
5
Comment les commentaires sont-ils généralement analysés?
Comment les commentaires sont-ils généralement traités dans les langages de programmation et le balisage? J'écris un analyseur pour un langage de balisage personnalisé et je veux suivre le principe de la moindre surprise , donc j'essaie de déterminer la convention générale. Par exemple, un commentaire incorporé dans un jeton devrait-il …
31 parsing  comments 
6
Guide du débutant pour rédiger des commentaires?
Voulez-vous améliorer ce post? Fournissez des réponses détaillées à cette question, y compris des citations et une explication de la raison pour laquelle votre réponse est correcte. Les réponses sans suffisamment de détails peuvent être modifiées ou supprimées. Cette question a été migrée depuis Stack Overflow car il est possible …
9
Style et recommandations de commenter le code
Cette question a été migrée depuis Stack Overflow car il est possible d'y répondre sur Software Engineering Stack Exchange. Migré il y a 8 ans . Je veux avoir de vos conseils et expérience d'écriture de commentaires dans votre code. Comment les rédigez-vous de la manière la plus simple et …
6
Comment résoudre le problème des commentaires imbriqués
Il n'apparaît pas dans une seule langue que les commentaires ne peuvent pas être imbriqués. Avez-vous une bonne solution à ce problème? Une solution de contournement en C / C ++ et Java consiste à utiliser uniquement le commentaire sur une seule ligne, mais il devient alors impossible de commenter …
23 java  c++  python  c  comments 
21
Code d'auto-documentation contre. Code commenté
Verrouillé . Les commentaires sur cette question ont été désactivés, mais elle accepte toujours de nouvelles réponses et d'autres interactions. Apprenez-en plus . J'ai effectué une recherche mais je n'ai pas trouvé ce que je cherchais, n'hésitez pas à me lier si cette question a déjà été posée. Plus tôt …
6
Pourquoi est-il mal de commenter le code, puis de le supprimer progressivement pour garder une trace de ce que j'ai déjà fait et de ce qui reste à faire?
Chaque fois que je découvre qu'une grande partie de mon code doit être modifiée, soit parce qu'elle est incorrecte, soit parce qu'elle doit être adaptée aux changements architecturaux majeurs nécessités par d'autres raisons, voici ce que je fais généralement: Je commente tout le code que je soupçonne de devoir changer. …
En utilisant notre site, vous reconnaissez avoir lu et compris notre politique liée aux cookies et notre politique de confidentialité.
Licensed under cc by-sa 3.0 with attribution required.