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...
Fermé . Cette question est basée sur l'opinion . Il n'accepte pas actuellement de réponses. Voulez-vous améliorer cette question? Mettez à jour la question afin d'y répondre avec des faits et des citations en modifiant ce message . Fermé il y a 5 ans . J'ai vu cela posé dans la SO Tavern , donc je...
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...
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...
Fermé . Cette question est basée sur l'opinion . Il n'accepte pas actuellement de réponses. Voulez-vous améliorer cette question? Mettez à jour la question afin d'y répondre avec des faits et des citations en modifiant ce message . Fermé il y a 4 ans . Je commence tout juste la programmation...
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...
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....
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...
Aujourd'hui, commenter est plus facile que jamais. En Java, il existe de belles techniques pour lier les commentaires aux classes, et les IDE Java sont bons pour créer des shells de commentaires pour vous. Des langages comme Clojure vous permettent même d'ajouter une description d'une fonction dans...
Je recherche une recommandation de bonne pratique pour les commentaires XML en C #. Lorsque vous créez une propriété, il semble que la documentation XML attendue se présente sous la forme suivante: /// <summary> /// Gets or sets the ID the uniquely identifies this <see cref="User" />...
À partir de certains projets open source, j'ai rassemblé le style de codage suivant void someFunction(bool forget); void ourFunction() { someFunction(false /* forget */); } J'ai toujours un doute sur ce que cela falsesignifie ici. Cela signifie-t-il "oublier", ou "oublier" fait-il référence à son...
J'ai vu de nombreux numéros de problème à partir des commentaires du code jQuery . (En fait, il y avait 69 numéros de problème dans le code jQuery.) Je pense que ce serait une bonne pratique, mais je n'ai jamais vu de directives. S'il s'agit d'une bonne pratique, quelles sont les lignes directrices...
Fermé . Cette question est basée sur l'opinion . Il n'accepte pas actuellement les réponses. Voulez-vous améliorer cette question? Mettez à jour la question afin d'y répondre avec des faits et des citations en modifiant ce message . Fermé il y a 4 ans . J'ai souvent vu de tels commentaires...
Quelques-uns le font, mais aucun des plus populaires pour autant que je sache. Y a-t-il quelque chose de mal à imbriquer des commentaires? Je prévois d'avoir des commentaires de bloc imbriqués dans la (petite) langue sur laquelle je travaille, mais je voudrais savoir si c'est une mauvaise...
Le développeur senior de notre boutique insiste sur le fait que chaque fois que le code est modifié, le programmeur responsable doit ajouter un commentaire en ligne indiquant ce qu'il a fait. Ces commentaires ressemblent généralement à// YYYY-MM-DD <User ID> Added this IF block per bug 1234....
L'un des développeurs de mon équipe pense qu'il est nécessaire d'écrire un commentaire javadoc pour CHAQUE paramètre dans la signature d'une méthode. Je ne pense pas que cela soit nécessaire et, en fait, je pense que cela peut même être nocif. Tout d'abord, je pense que les noms de paramètres...
Dans une certaine base de code, vous pouvez voir des commentaires indiquant des choses comme: // Workaround for defect 'xxx', (See bug 1434594 on Sun's bugparade) J'ai donc quelques questions, mais elles sont toutes liées. Est-il correct de mettre un lien vers les questions SO dans les commentaires...
Dans l'état actuel des choses, cette question ne convient pas à notre format de questions / réponses. Nous nous attendons à ce que les réponses soient étayées par des faits, des références ou une expertise, mais cette question suscitera probablement un débat, des arguments, des sondages ou une...
Est-ce considéré comme une mauvaise pratique de jeter NotImplementedExceptiondu code que vous n'avez pas encore écrit? Peut-être que les commentaires TODO seraient considérés comme plus
Il est difficile de dire ce qui est demandé ici. Cette question est ambiguë, vague, incomplète, trop large ou rhétorique et on ne peut raisonnablement y répondre sous sa forme actuelle. Pour obtenir de l'aide pour clarifier cette question afin qu'elle puisse être rouverte, visitez le centre d'aide...