Fragen zum Schreiben von Kommentaren in Code.
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...
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,...
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...
Ein Kollege von mir glaubt, dass die Verwendung von In-Code-Kommentaren (dh keine Javadoc-Methode oder Klassenkommentare) ein Codegeruch ist . Was denkst
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...
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...
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());
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...
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,...
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...
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 ....
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...
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...
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....
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...
Wir wurden gebeten, Kommentare mit Start-Tags, End-Tags, Beschreibung, Lösung usw. für jede Änderung hinzuzufügen, die wir im Rahmen der Behebung eines Fehlers / der Implementierung eines CR am Code vornehmen. Mein Anliegen ist, bietet dies einen Mehrwert? Wie es ist, haben wir alle Details in der...
Ist es eine gute Praxis, die Fehlernummern in der Datei selbst in einem Kopfzeilenkommentar abzulegen? Die Kommentare würden ungefähr so aussehen: MODIFIED (MM/DD/YY) abc 01/21/14 - Bug 17452317 - npe in drill across in dashboard edit mode cde 01/17/14 - Bug 2314558 - some other error...
Ich sehe ständig Leute, die behaupten, dass "Kommentare dazu neigen, veraltet zu sein". Die Sache ist, ich denke, ich habe vielleicht zwei oder drei veraltete Kommentare in meiner gesamten Karriere gesehen. Veraltete Informationen in separaten Dokumenten kommen immer wieder vor, aber meiner...
Während des Programmierens werden Sie einige Kommentare erhalten, die den Code erklären, und einige Kommentare, die den Code entfernen: // A concise description const a = Boolean(obj); //b = false; Gibt es eine gute Methode, um schnell zu analysieren, welche welche ist? Ich habe mit der...
Angenommen, ein Kommentar passt nicht in die Zeile, für die er gilt (oder kann nicht), sollte man den Kommentar vor oder nach dem Code schreiben? Nun, wo auch immer zukünftige Leser den Umfang des Kommentars am besten verstehen werden. Mit anderen Worten, überall dort, wo die meisten Programmierer...