Versuchen Sie, Code -Kommentare zu vermeiden, wenn Sie Webseiten refactorieren

Wulin.com (www.vevb.com) Artikel Einführung: Ich habe noch nie gesehen, dass eine wissenschaftliche Forschung dies beweist, aber im Bereich Software ist es wie ein Dogma oder ein gemeinsamer Glaube. Aufgrund seiner Existenz ist es wichtig, Software problemlos zu schreiben und auf den lesbaren Codetyp zu achten. Diese Anforderungen können durch einige Techniken erreicht werden, von denen eine Code -Kommentare schreibt.

Haftungsausschluss: Was ich über das Vermeiden von Code -Kommentaren gesagt habe, bedeutet nicht, dass ich keine Kommentare schreibe, was bedeutet, dass ich nicht so viel wie möglich Code -Kommentare schreibe, aber ich schreibe sie immer noch, wenn ich das Gefühl habe, dass es sich lohnt.

Wir verbringen mehr Zeit damit, Software zu lesen als Software zu schreiben, und ich habe noch nie gesehen, dass wissenschaftliche Forschung dies beweist, aber im Bereich Software ist es wie ein Dogma oder eine gemeinsame Meinung. Aufgrund seiner Existenz ist es wichtig, Software problemlos zu schreiben und auf den lesbaren Codetyp zu achten. Diese Anforderungen können durch einige Techniken erreicht werden, von denen eine Code -Kommentare schreibt.

Wenn Sie über Code -Kommentare sprechen, gibt es immer endlose Debatten. Sollten wir Kommentare verwenden, um die Rolle unseres Codes zu veranschaulichen? Sollten wir uns auf die Ausdruckskraft des Codes konzentrieren, ohne Kommentare zu benötigen, um beim Lesen zu helfen? Joe Kunk schrieb einen Blog über das Argument - sollten Sie nicht Kommentare schreiben. Einige Leute sagen, dass gut dokumentierter Code als guter Code angesehen wird, und einige sagen, dass Kommentare vermieden werden sollten, da Kommentare häufig verwendet werden, um schlechten Code zu erklären/zu verbergen.

Meiner Meinung nach sollten wir nach dem Einfluss von Büchern sicherstellen, dass der Code ordentlich und leicht zu refaktor ist, es vermeiden, Kommentare zu schreiben, es sei denn, wir haben einen guten Grund, Kommentare (z. B. mathematische Algorithmen) zu schreiben, oder aufgrund der Anforderungen oder Prozesse des Unternehmens sind wir dazu verpflichtet. Hier sind fünf Bedenken hinsichtlich der Notizen.

Kommentarer Code ist ein guter Code. Es gibt ein solches Sprichwort, daher fügen die Leute den Code oft Kommentare hinzu, um den Code schön zu machen. Wenn wir Kommentare hinzufügen, um den Code zu interpretieren, ist es wie ein Signal: Vielleicht schreiben wir einen schlechten Code. Wenn wir einen Kommentar schreiben wollen, sollten wir uns fragen, ob wir ihn durch Reinigen des Codes lesbarer machen können.

Kommentare sind normalerweise die zweite Version des Code. Wir wiederholen uns tatsächlich, wenn wir Kommentare für eine Funktion schreiben. Wir haben das trockene Prinzip verletzt (nicht wiederholen). Wir verbringen mehr Zeit und fügen Komplexität hinzu. Wenn sich die Anforderungen ändern, muss sich auch der Code ändern, und wenn wir Kommentare schreiben, müssen wir sie auch ändern. Nehmen Sie sich also die doppelte Zeit, in der Sie ausgeben. Wir können diese Zeit nutzen, um unseren Code zu verbessern oder neue Funktionen zu entwickeln.

Wenn wir den Code ändern, verwenden wir Compiler, IDE- und Unit -Test -Tools, um zu helfen, und es gibt keine Kommentare und keine ähnlichen Tools. Sie können sich nicht auf Tools oder Unit -Tests verlassen, um sicherzustellen, dass sie korrekt verwendet werden, Anmerkungen datieren usw. Sobald Sie einen Kommentar geschrieben haben, da er nicht testbar ist und nicht auf seine Genauigkeit achten kann, wird er unentschieden erhalten, sobald es schief geht.

Wenn Kommentare und Code aus ihm herauskommen, wird es normalerweise weniger bedeutungsvoll. Wenn ein Programmierer es liest, kann es irregeführt werden. Auch ohne irreführende Lesen müssen Sie den Quellcode lesen, um herauszufinden, was Sie tun. Wenn unser Chef uns für eine Änderung benötigt, sollten wir uns die Kommentare oder Code ansehen, wenn wir eine Änderung vornehmen müssen? Natürlich werden wir uns den Code ansehen.

Einige Kommentare (wie die unten) nehmen viele Zeilen auf, was zu einem Problem wird, wenn Sie mehr Code sehen möchten.

/**

*

* @param Titel den Titel der CD

* @param Autor der Autor der CD

* @Param verfolgt die Anzahl der Tracks auf der CD

* @param durationInminutes Die Dauer der CD in Minuten

*/

public void addCD (String -Titel, String -Autor,

int Tracks, int durationInminutes) {

CD CD = New CD ();

cd.title = title;

CD.Author = Autor;

CD.Tracks = Tracks;

CD.Duration = Dauer;

CDList.Add (CD);

}