Als «comments» getaggte Fragen

Fragen zum Schreiben von Kommentaren in Code.

16
Was stimmt nicht mit Kommentaren, die komplexen Code erklären?
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 …


17
Codierungsstandard für Klarheit: Jede Codezeile kommentieren?
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. …


12
Mein Kunde möchte 25% der Kommentare in meinem aktuellen Projekt, wie soll ich reagieren? [geschlossen]
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 …

17
Machen TODO-Kommentare Sinn? [geschlossen]
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 …

9
Clean Code-Kommentare vs. Klassendokumentation
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 …

13
Kann auskommentierter Code eine wertvolle Dokumentation sein?
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 …



17
Wie kann ich meinen Chef (höflich) bitten, seinen Code zu kommentieren?
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 

9
Was bedeutet XXX in einem Kommentar? [geschlossen]
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 …


7
TODO-Kommentare mit Fristen?
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 …

11
Warum sind /// Kommentarblöcke wichtig?
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 

Durch die Nutzung unserer Website bestätigen Sie, dass Sie unsere Cookie-Richtlinie und Datenschutzrichtlinie gelesen und verstanden haben.
Licensed under cc by-sa 3.0 with attribution required.