Questions marquées «comments»

Beaucoup de gens affirment que "les commentaires devraient expliquer" pourquoi "mais pas" comment "". D'autres disent que "le code devrait être auto-documenté" et que les commentaires devraient être rares. Robert C. Martin affirme que (reformulé selon mes propres mots) souvent "les commentaires sont des excuses pour un code mal écrit". …

236 programming-practices  documentation  comments 

Un membre de mon équipe évite systématiquement de faire des commentaires dans son code. Son code n'est pas auto-documenté et les autres programmeurs ont du mal à comprendre son code. Je lui ai demandé à plusieurs reprises de commenter son code, mais il ne fait que donner des excuses ou …

184 teamwork  team  comments 

J'ai travaillé dans des ateliers qui produisent des logiciels essentiels à la vie courante et j'ai traité des règles de commentaire destinées à garder le code lisible et potentiellement à sauver des vies. D'après mon expérience, l'exigence devient une corvée de cerveau fatal d'être cochée dans une liste de contrôle …

142 coding-standards  comments  standards  naming-standards  standardization 

Un de mes collègues estime que toute utilisation de commentaires dans le code (c.-à-d. Sans méthode de style javadoc ni commentaires de classe) est une odeur de code . Qu'est-ce que tu penses?

100 comments  anti-patterns 

développeur junior ici. Je travaille actuellement seul sur une application Web pour un gros client de mon entreprise. J'ai commencé le mois dernier. Le client souhaite au moins 25% de commentaires dans chacun de ses projets de logiciels. J'ai vérifié le code des applications précédentes et voici mes observations: chaque …

96 project-management  comments  client-relations  hierarchy 

Je travaille sur un assez gros projet et j'ai la tâche de faire quelques traductions. Il y avait des tonnes d'étiquettes qui n'ont pas été traduites et alors que je cherchais dans le code, j'ai trouvé ce petit morceau de code. //TODO translations Cela m'a fait réfléchir sur le sens …

86 documentation  comments 

Je discute avec mes nouveaux collègues au sujet des commentaires. Nous aimons tous les deux Clean Code , et je suis parfaitement d'accord avec le fait que les commentaires de code en ligne doivent être évités et que les noms de classe et de méthode doivent être utilisés pour exprimer …

83 comments  clean-code 

J'ai écrit le code suivant: if (boutique == null) { boutique = new Boutique(); boutique.setSite(site); boutique.setUrlLogo(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getLogo()); boutique.setUrlBoutique(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getUrl()); boutique.setNom(fluxBoutique.getNom()); boutique.setSelected(false); boutique.setIdWebSC(fluxBoutique.getId()); boutique.setDateModification(new Date()); boutiqueDao.persist(boutique); } else { boutique.setSite(site); boutique.setUrlLogo(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getLogo()); boutique.setUrlBoutique(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getUrl()); boutique.setNom(fluxBoutique.getNom()); //boutique.setSelected(false); boutique.setIdWebSC(fluxBoutique.getId()); boutique.setDateModification(new Date()); boutiqueDao.merge(boutique); } Il y a une ligne commentée ici. Mais je pense que cela rend le …

83 documentation  comments 

Tout d'abord, dans cette question, je voudrais rester à l'écart de la polémique sur la question de savoir si les commentaires sur le code source sont bons ou mauvais. J'essaie simplement de comprendre plus clairement ce que les gens veulent dire quand ils parlent de commentaires qui vous disent POURQUOI, …

78 documentation  comments 

Je sais que Subversion (ce que nous utilisons au travail) peut être configuré pour exiger des commentaires sur les commits, mais je ne suis pas en position de pouvoir simplement l'activer. Je sais que la raison pour laquelle je commente mes commits est parce qu’il est utile, ne serait-ce qu’en …

78 version-control  comments 

Mon patron m'enseigne (je viens de terminer mes études et il cherchait quelqu'un avec un peu d'expérience en programmation. Il m'a donc choisi pour me former à ce que cette entreprise se spécialise) et a commencé à travailler avec des applications ASP.NET MVC , du HTML et du CSS. . …

72 comments 

Que veulent dire généralement les gens chaque fois que vous voyez XXXun commentaire? De temps en temps, je vais voir un commentaire comme celui-ci: # XXX - This widget really should frobulate the whatsit Bien sûr, je peux dire ce que le commentaire signifie, mais que signifie généralement le XXX? …

72 comments  coding-standards 

Je viens juste de me retrouver à écrire le commentaire suivant dans un code (archaïque Visual Basic 6.0) que j'écrivais: If WindowState <> 1 Then 'The form's not minimized, so we can resize it safely '... End if Je ne suis pas sûr de savoir pourquoi j'utilise inconsciemment "nous" dans …

63 comments  coding-standards 

Contexte Je travaille dans une équipe qui cherche à mettre en œuvre des déploiements sans temps d'arrêt. Nous prévoyons d'utiliser une stratégie de déploiement bleu / vert pour y parvenir. En réalisant cette recherche, je réalise notamment à quel point il est difficile de modifier les bases de données. Une …

51 continuous-integration  deployment  comments  continuous-delivery 

Quelqu'un a dit une fois que nous devrions préfixer toutes nos méthodes avec les /// <summary>blocs de commentaires (C #) mais n’a pas expliqué pourquoi. J'ai commencé à les utiliser et j'ai constaté qu'ils m'ennuyaient un peu, alors j'ai cessé de les utiliser, sauf pour les bibliothèques et les méthodes …

49 c#  comments