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...
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...
Wir überarbeiten gerade eine 20 Jahre alte Codebasis und diskutieren mit meinem Kollegen über das Kommentarformat im Code (plsql, java). Es gibt kein Standardformat für Kommentare, aber in den meisten Fällen machen die Leute im Kommentar so etwas: // date (year, year-month, yyyy-mm-dd,...
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...
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...
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 .
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 möchte wissen, wie ich am besten einen Kommentar hinzufügen kann, um eine veraltete Klasse in Java zu identifizieren. Sollte ich den vorherigen Kommentar entfernen, der oben in der Klasse hinzugefügt wurde, damit ein anderer Programmierer weiß, wofür diese Klasse gedacht war, oder sollte ich...
Gibt es gängige Methoden zum Kommentieren der regulären Ausdrücke: Inline-Kommentare, die auf einen anderen Teil von RegEx verweisen, oder allgemeine Kommentare für alle
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...
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...
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...
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...
Mir ist klar, dass das Format "Header-Kommentar" von Programmierer zu Programmierer unterschiedlich ist, aber was wäre ein Beispiel für einen "guten"
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...
Ist es eine gute Praxis, Kommentare für weithin bekannte Methoden wie equals, compareTo usw. zu schreiben? Betrachten Sie den folgenden Code. /** * This method compares the equality of the current object with the object of same type */ @Override public boolean equals(Object obj) { //code for equals...
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:...
Ich bin dabei, ein Projekt zu verlassen, und bevor ich gehe, hat mein Chef mich gebeten, Code zu dokumentieren (ich habe nicht sehr gut dokumentiert). Es ist keine große Sache, das Projekt ist nicht besonders komplex. Aber ich finde in meiner Dokumentation Stellen, an denen ich sagen möchte:...
Das mag eine dumme Frage sein, aber sie ist schon eine Weile in meinem Hinterkopf und ich kann nirgendwo anders eine anständige Antwort finden. Ich habe einen Lehrer, der sagt, wir sollten jeden Parameter explizit mit einer Beschreibung auflisten, auch wenn es nur einen gibt. Dies führt zu vielen...
Ich möchte Javadoc auf trockene Weise schreiben. Aber das Orakel-Dokument über Javadoc sagt, dass man dasselbe noch einmal in einen Kommentar zur Überladungsmethode schreiben soll. Kann ich Wiederholungen nicht