C # Kommentare zu closing {}

Question

Ich habe ein wenig mit DevExpress CodeRush und Umgestalten gearbeitet! Pro in dieser Woche, und ich nahm einen commentor Plug-in bis das wird automatisch Kommentare erzeugen, wie Sie Code eingeben.

Ich will nicht darüber, wie gut einen Job gehen, es tut grundlegende Bedeutung herauszuzupicken (ziemlich gut, eigentlich), aber es ist Default-Implementierung hat eine Frage stellen.

In der Standardeinstellung ein} Zeichen eingeben um einen Block zu schließen im Plugin führt einen Kommentar wie die folgenden ...

using(MyType myType = new MyType())
{
    myType.doWork();
} // using

(d. Hinzufügen um einen Kommentar zu der schließenden Klammer Kennzeichnung, wo sie geöffnet wurde.)

Während ich sehen kann, dass es Fälle gibt, in denen dieses Verhalten von großem Nutzen sein kann, glaube ich, dass der resultierende Code sehr unordentlich aussieht mit all den zusätzlichen kommentieren.

Ich habe mich gefragt, was andere Leute; s auf diese Art von Kommentar nehmen war. Nicht nur aus akademischer Sicht, aber wenn ich eine gute Anzahl von negativen Kommentaren über sie bekommen kann ich entscheiden, ob sie auf meine Mitarbeiter zuzufügen oder sie Streifen aus.

Answer 1

Ich denke, Kommentare wie die nutzlos sind, es sei denn natürlich der Code ist schrecklich. Mit dem richtigen Formatierung des Codes ist es nicht schwer zu sehen, wo ein Block beginnt und wo ein Block endet, weil in der Regel die Blöcke eingerückt sind.

Edit: Wenn eine Prozedur so groß ist, dass nicht ohne weiteres ersichtlich ist, welche Code-Block wird durch eine Klammer geschlossen ist, dann sollte es schon sein beschreibenden Kommentare, das Verfahren beschreiben, sowieso, und diese Kommentare würden nur Unordnung sein.

Answer 2

Ich finde die Idee eines Plugins, die Kommentare von Code genrates ziemlich nutzlos. Wenn es von der Maschine abgeleitet werden kann, dann kann es auch von jemandem lesen zu entnehmen. Die Kommentare sind sehr wahrscheinlich völlig überflüssig.

Ich glaube, dass diejenigen, schließende Klammer Kommentar unordentlich ist, gibt es Informationen, die besser direkt von den IDE zur Verfügung gestellt wird, wenn die Person es will.

Answer 3

IMO jeden Kommentar, der beschreibt, was der Code schon sagt Ihnen ist nicht erforderlich.

Wenn Sie wirklich Codeblöcke haben, die so lang sind, dass Sie viel blättern haben dort zu sehen beginnen Sie etwas falsch gemacht haben und können prüfen, den Code bis spalten.

Answer 4

Bad schlecht Kommentar Stil - es führt eine Wartungsaufwand in der Code-Basis

.

Ich habe bekannte Ex-VB Programmierer, die Spuren von }s in C-Syntax Code gefunden verwirrend zu sein, aber in diesem Szenario die wirkliche Lösung ist, Ihren Code Refactoring tiefe Verschachtelung zu verhindern und zu lange Funktionen und / oder Codeblocks .

Answer 5

Vielleicht nützlich, wenn die Verwendung von Block erstreckt sich über eine Seite in den IDE, aber dann haben Sie andere Probleme bekommen zu befürchten. In diesem Fall habe ich mit der richtigen Einrücken bekommen durch und eine IDE, die die passende Klammer hebt, wenn ich eine auswählen.

Ich gebe ihm einen Daumen nach unten im Allgemeinen, aber mit potentiellem Nutzen, wenn Sie nicht einen langen Block sonst vermeiden.

Answer 6

Manchmal werden Sie sehr große Code-Blöcke erhalten, oder viele verschachtelte Blöcke schließen zusammen. Manchmal benutze ich dieses Modell auch in Fällen wie diesem, aber definitiv nicht die ganze Zeit. Ich beschränke es nicht zu kodieren entweder: HTML stark von dieser Art von profitieren kann „schließen zu kommentieren“:

<div id="content">
    <div id="columns">
        <div class="column">

            <!-- .. snip a lot of lines .. -->

        </div> <!-- .column -->
    </div> <!-- #columns -->
</div> <!-- #content -->

Answer 7

Diese Art von nur Kommentare sind nützlich bei sehr langen Code-Blöcke, wo Du viele verschachtelte Blöcke haben. Aber das sagte dies nicht der Fall in erster Linie sein sollte, wie viele verschachtelte Blöcke und lange Methoden für Refactoring nennen. So mag ich das nicht überhaupt, wie der Leser kann natürlich sehen, welche Code-Block ist.

Answer 8

Ich denke, nützlicher als Kommentare ein IDE-Feature wären nicht nur Paare von Klammern markieren passend, sondern auch auf einem Tooltip die openining Zeile angezeigt werden, so dass, wenn Sie über die schließende Klammer in Ihrem Beispiel schweben es kommen würde, mit "verwenden (MyType myType = new MyType ())" in einem Tooltip.

Dies würde ermöglichen, leicht Sinn von komplexen verschachtelten Klammern für große Funktionen, ohne ständige visuelle Unordnung bereitstellt.

Answer 9

Ich finde es immer nützlich, sich daran zu erinnern ...

Klar, gut geschriebener Code wird genug von einer Erklärung von das, was der Code für einen kompetenten Programmierer tut, um es aufzuheben.

Kommentare im Code überlassen werden sollte zu erklären, warum der Code tut es!

Mit anderen Worten, verwenden Kommentare der Leser Ihres Codes zu helfen, den Algorithmus zu verstehen, oder was der Code soll erreichen , nicht wie es zu erreichen it!

Sie möchten vielleicht Besuche von Jeff Atwood .

Answer 10

Sie es nicht tun, fügt es einfach Lärm, wenn alle über den Ort verwendet, und außerdem die richtige Vertiefung sollte die Lesbarkeit Problem lösen.

Answer 11

Ich würde halten es ausgeschaltet. Ich habe nur einen Punkt bei der Verwendung dieser sehen, wenn Sie im selben Ort mehrere Blöcke endet (längere oder kürzere Blöcke) - ich habe sie selbst in einigen Fällen wie diese verwendet werden. Allerdings, wenn sie verwendet wird, wäre es besser, sie manuell hinzuzufügen, in sorgfältig ausgewählten Orten statt einig automatisiertes Tool mit Zugabe von ihnen.

Answer 12

Wenn Sie haben zu prüfen, ob eine bestimmte Art von Kommentar verwendbar ist oder nicht, ist es höchstwahrscheinlich letztere.

Die Kommentare sind zur Erläuterung bestimmter Code-Blöcke oder ein Unternehmen in seiner Gesamtheit, auf Verständnis nachzulassen; nicht die Formatierung zu erleichtern zu lesen.

Mit immer ein Plugin, um dieses Verhalten anzupassen ist sowohl fettleibig und hässlich.

Answer 13

Ich bin damit einverstanden es gibt viel bessere Möglichkeiten, zu beschreiben, was ein Code tut.

Wenn Sie einen langen Körper von Code durch einen einzigen informativen Kommentar voran wie // Fix Work Item, können Sie diesen Code nehmen und sie als seine eigene Methode Refactoring. Dann nutzen Sie den Kommentar als den Namen der neuen Methode, FixWorkItem (). Dadurch ist eine schnelle Möglichkeit, Ihren Code selbsterklärend zu machen und vielleicht sogar einige Designmerkmale zeigen Sie vorher nicht bemerkt.

Halten Sie ein Auge für Einzeiler Kommentare wie die als potentieller refactors, die automatisch von dem IDE behandelt werden können. Code, der selbst dokumentiert ist besser als selbst die besten geschriebenen Standalone-Kommentare, außer natürlich, wenn Absicht zu beschreiben.