Als «comments» getaggte Fragen

Fragen zum Schreiben von Kommentaren in Code.

11
Versionskontrollkommentare - Vergangenheit oder Gegenwart [geschlossen]
Geschlossen . Diese Frage ist meinungsbasiert . Derzeit werden keine Antworten akzeptiert. Möchten Sie diese Frage verbessern? Aktualisieren Sie die Frage, damit sie mit Fakten und Zitaten beantwortet werden kann, indem Sie diesen Beitrag bearbeiten . Geschlossen vor 4 Jahren . Was tun / empfehlen andere Benutzer für Versionskontrollkommentare - …
3
Sind docblock-Schreibweisen bei strikter Eingabe überflüssig?
Ich habe eine ziemlich große private Codebasis, die sich seit ungefähr zehn Jahren entwickelt hat. Ich verwende phpDocumentor nicht, aber da die Verwendung von docblock-Abschnitten in Open Source-Projekten zum Standard geworden ist, habe ich das Schreiben von docblocks auch für alle öffentlichen Methoden in meinem Repository übernommen. Die meisten Blöcke …
12 php  comments 
2
Ist es eine gute Idee, Code mit Refactoring-Kommentaren zu verbreiten?
Ich arbeite an einem "Spaghetti-Code" -Projekt, und während ich Fehler behebe und neue Funktionen implementiere, führe ich auch einige Umgestaltungen durch, um den Code Unit-testbar zu machen. Der Code ist oft so eng miteinander verbunden oder kompliziert, dass das Beheben eines kleinen Fehlers dazu führen würde, dass viele Klassen neu …
7
Sind mehr Kommentare in Umgebungen mit hohem Umsatz besser?
Ich habe heute mit einem Kollegen gesprochen. Wir arbeiten an Code für zwei verschiedene Projekte. In meinem Fall bin ich die einzige Person, die an meinem Code arbeitet. In ihrem Fall arbeiten mehrere Personen an derselben Codebasis, einschließlich Koop-Studenten, die ziemlich regelmäßig (zwischen 8 und 12 Monaten) kommen und gehen. …
6
Werden Kommentare als Dokumentationsform betrachtet?
Wenn ich kleine Skripte für mich selbst schreibe, staple ich meinen Code hoch mit Kommentaren (manchmal kommentiere ich mehr als ich codiere). Viele Leute, mit denen ich spreche, sagen, dass ich diese Skripte dokumentieren sollte, obwohl sie persönlich sind, damit ich bereit wäre, wenn ich sie jemals verkaufen würde. Aber …
3
Sind XML-Kommentare erforderlich?
Früher war ich ein Fan davon, XML-Kommentare für die Dokumentation zu benötigen. Ich habe meine Meinung seitdem aus zwei Hauptgründen geändert: Wie guter Code sollten Methoden selbsterklärend sein. In der Praxis sind die meisten XML-Kommentare nutzloses Rauschen, das keinen zusätzlichen Wert bietet. Oft verwenden wir einfach GhostDoc, um generische Kommentare …
5
Sollte ein Methodenkommentar sowohl eine Zusammenfassung als auch eine Rückgabebeschreibung enthalten, wenn sie oft so ähnlich sind?
Ich bin ein Befürworter von ordnungsgemäß dokumentiertem Code und bin mir der möglichen Nachteile bewusst . Das liegt außerhalb des Rahmens dieser Frage. Ich befolge gerne die Regel, XML-Kommentare für jedes öffentliche Mitglied hinzuzufügen , wenn man bedenkt, wie sehr ich IntelliSense in Visual Studio mag. Es gibt jedoch eine …
1
Was bedeutet "TILT" in einem Kommentar?
Ich lese Clean Code von Robert C. Martin und der Satz kommt TILTunerklärlicherweise in einigen Codebeispielen vor. Beispiel (übrigens in Java): ... public String errorMessage() { switch (status) { case ErrorCode.OK: // TILT - Should not get here. return ""; case ErrorCode.UNEXPECTED_ARGUMENT: return "Unexpected argument"; case ErrorCode.MISSING_ARGUMENT: return "Missing argument"; …
8
Warum schreibt jeder To-Do-Kommentare in Großbuchstaben? [geschlossen]
Diese Frage passt derzeit nicht zu unserem Q & A-Format. Wir erwarten, dass die Antworten durch Fakten, Referenzen oder Fachwissen gestützt werden, aber diese Frage wird wahrscheinlich zu Debatten, Argumenten, Umfragen oder erweiterten Diskussionen führen. Wenn Sie der Meinung sind, dass diese Frage verbessert und möglicherweise erneut geöffnet werden kann, …
9 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.