Als «comments» getaggte Fragen

Fragen zum Schreiben von Kommentaren in Code.

9
Was ist eine gute Möglichkeit, if-else-Klauseln zu kommentieren? [geschlossen]
Aus heutiger Sicht passt diese Frage nicht zu unserem Q & A-Format. Wir erwarten, dass die Antworten durch Fakten, Referenzen oder Fachwissen gestützt werden, aber diese Frage wird wahrscheinlich Debatten, Argumente, Abstimmungen oder erweiterte Diskussionen hervorrufen. Wenn Sie der Meinung sind, dass diese Frage verbessert und möglicherweise erneut geöffnet werden …
15 comments 
4
Ist es gerechtfertigt, Konfliktmarkierungen im eingecheckten Code zu belassen?
Betrachten Sie Konfliktmarkierungen. dh: <<<<<<< branch blah blah this ======= blah blah that >>>>>>> HEAD In dem speziellen Fall, der mich veranlasst hat, diese Frage zu stellen, hat das zuständige Teammitglied gerade eine Zusammenführung von Upstream zu unserer Niederlassung durchgeführt und diese in einigen Fällen als Kommentar als eine Art …
6
Kommentieren Sie den Quellcode mit Diagrammen als Kommentare
Ich schreibe viel (hauptsächlich C ++ und Javascript) Code, der sich mit rechnergestützter Geometrie und Grafiken sowie solchen Themen befasst. Daher habe ich festgestellt, dass visuelle Diagramme ein unverzichtbarer Bestandteil des Prozesses zur Lösung von Problemen sind. Ich habe gerade festgestellt, dass "oh, wäre es nicht fantastisch, wenn ich ein …
7
Was soll ich in den Header der Klassendokumentation aufnehmen?
Ich suche nach einem informativen Klassendokumentationsformat für meine Entity-, Business Logic- und Data Access-Klassen. Ich fand folgende zwei Formate von hier Format 1 ///----------------------------------------------------------------- /// Namespace: <Class Namespace> /// Class: <Class Name> /// Description: <Description> /// Author: <Author> Date: <DateTime> /// Notes: <Notes> /// Revision History: /// Name: Date: Description: …
1
Einführung zusätzlicher lokaler Variablen als Kommentarersetzung
Ist es sinnvoll, zusätzliche, technisch überflüssige lokale Variablen zu verwenden, um zu beschreiben, was passiert? Beispielsweise: bool easyUnderstandableIsTrue = (/* rather cryptic boolean expessions */); if(easyUnderstandableIsTrue) { // ... } Wenn es um technischen Aufwand geht, erwarte ich, dass der Compiler diese zusätzliche Zeile optimiert. Aber wird es als unnötiger …
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.