Als «comments» getaggte Fragen

Viele Leute behaupten, "Kommentare sollten erklären, warum, aber nicht wie". Andere sagen, "Code sollte sich selbst dokumentieren" und Kommentare sollten knapp sein. Robert C. Martin behauptet, dass (in meinen eigenen Worten umformuliert) Kommentare häufig "Entschuldigungen für schlecht geschriebenen Code" sind. Meine Frage lautet wie folgt: Was ist falsch daran, einen …

236 programming-practices  documentation  comments 

Eines meiner Teammitglieder vermeidet konsequent Kommentare in seinem Code. Sein Code ist nicht selbstdokumentierend, und andere Programmierer haben Schwierigkeiten, seinen Code zu verstehen. Ich habe ihn mehrmals gebeten, seinen Code zu kommentieren, aber er gibt nur Ausreden oder behauptet, dass er es später tun wird. Sein Anliegen ist, dass das …

183 teamwork  team  comments 

Ich habe in Geschäften gearbeitet, die lebenswichtige Software herstellen, und habe mich mit Kommentierungsregeln befasst, die den Code lesbar halten und möglicherweise Leben retten sollten. Meiner Erfahrung nach ist die Anforderung, von einer Checkliste gestrichen zu werden, hirnschmerzhaft und hilft mir nicht, mich darauf zu konzentrieren, verständlichen Code zu schreiben. …

142 coding-standards  comments  standards  naming-standards  standardization 

Ein Kollege von mir glaubt, dass die Verwendung von In-Code-Kommentaren (dh keine Javadoc-Methode oder Klassenkommentare) ein Codegeruch ist . Was denkst du?

100 comments  anti-patterns 

Nachwuchsentwickler hier. Ich arbeite zurzeit alleine an einer Webanwendung für einen großen Kunden meines Unternehmens. Ich habe letzten Monat angefangen. Der Kunde möchte mindestens 25% der Kommentare in jedem seiner Softwareprojekte. Ich habe den Code früherer Anmeldungen überprüft und hier meine Beobachtungen: Jede Datei beginnt mit einem Kommentarblock (Paket, Datum …

96 project-management  comments  client-relations  hierarchy 

Ich arbeite an einem ziemlich großen Projekt und habe die Aufgabe, einige Übersetzungen dafür zu machen. Es gab Unmengen von Etiketten, die nicht übersetzt wurden, und während ich den Code durchsuchte, fand ich dieses kleine Stück Code //TODO translations Dies brachte mich dazu, über den Sinn dieser Kommentare für sich …

86 documentation  comments 

Ich habe einige Diskussionen mit meinen neuen Kollegen über das Kommentieren. Wir beide mögen Clean Code , und ich bin völlig in Ordnung mit der Tatsache, dass Inline-Code-Kommentare vermieden werden sollten und dass Klassen- und Methodennamen verwendet werden sollten, um auszudrücken, was sie tun. Ich bin jedoch ein großer Fan …

83 comments  clean-code 

Ich habe folgenden Code geschrieben: 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); } Hier steht eine auskommentierte Zeile. Aber ich denke, es macht den Code klarer, indem …

83 documentation  comments 

Zunächst möchte ich mich in dieser Frage von der Polemik fernhalten, ob das Kommentieren von Quellcode gut oder schlecht ist. Ich versuche nur klarer zu verstehen, was die Leute meinen, wenn sie über Kommentare sprechen, die Ihnen sagen, WARUM, WAS oder WIE. Wir sehen oft Richtlinien wie "Kommentare sollten Ihnen …

78 documentation  comments 

Ich weiß, dass Subversion (das, was wir bei der Arbeit verwenden) so konfiguriert werden kann, dass Kommentare zu Commits erforderlich sind, aber ich bin nicht in der Lage, dies einfach einzuschalten. Ich weiß, dass mein Grund für das Kommentieren meiner Commits darin besteht, dass es nützlich ist, wenn auch nur …

78 version-control  comments 

Ich werde von meinem Chef unterrichtet (ich habe gerade die Schule beendet und er wollte jemanden mit ein wenig Programmiererfahrung, deshalb hat er mich ausgewählt, um mich in den Spezialgebieten dieser Firma zu schulen) und fing an, mit ASP.NET MVC- Anwendungen, etwas HTML und CSS zu arbeiten . Mir geht …

72 comments 

Was bedeuten Menschen im Allgemeinen, wenn Sie XXXin einem Kommentar sehen. Gelegentlich sehe ich einen Kommentar wie diesen: # XXX - This widget really should frobulate the whatsit Natürlich kann ich sagen, was der Kommentar bedeutet, aber was bedeutet der XXX im Allgemeinen? Sagt es "Dies ist ein Hack" oder …

72 comments  coding-standards 

Ich habe gerade festgestellt, dass ich in einem (archaischen Visual Basic 6.0) Code, den ich geschrieben habe, den folgenden Kommentar geschrieben habe: If WindowState <> 1 Then 'The form's not minimized, so we can resize it safely '... End if Ich bin mir nicht sicher, warum ich unbewusst "wir" in …

63 comments  coding-standards 

Hintergrund Ich arbeite in einem Team, das Bereitstellungen ohne Ausfallzeiten implementieren möchte. Wir planen eine blau / grüne Bereitstellungsstrategie, um dies zu erreichen. Eines der Dinge, die mir bei der Recherche klar werden, ist, wie kompliziert es wird, Datenbankänderungen vorzunehmen. Ein einfacher Vorgang wie das Umbenennen einer Spalte kann 3 …

51 continuous-integration  deployment  comments  continuous-delivery 

Jemand hat einmal gesagt, wir sollten allen unseren Methoden die /// <summary>Kommentarblöcke (C #) voranstellen , haben aber nicht erklärt, warum. Ich habe angefangen, sie zu verwenden, und festgestellt, dass sie mich ziemlich geärgert haben. Daher habe ich sie mit Ausnahme von Bibliotheken und statischen Methoden nicht mehr verwendet. Sie …

49 c#  comments