Hören Sie auf, schlechte Kommentare in Ihren Code zu schreiben – Tipps für sauberen Code

Nov 26 2022

Einführung Kommentare sind eigentlich sehr nützlich beim Programmieren, wenn sie gut platziert sind. Aber meistens sind Kommentare nicht so „gut“.

Hören Sie bitte auf, Ihren Code zu kommentieren

Einführung

Kommentare sind eigentlich sehr nützlich beim Programmieren, wenn sie gut platziert sind. Aber meistens sind Kommentare nicht so „gut“.

Schlechte Kommentare können zu Fehlinformationen, Zeitverschwendung, schlechten Gewohnheiten usw. führen.

In diesem Artikel werde ich Ihnen zeigen, wie Sie es vermeiden können, schlechte Kommentare zu schreiben

Schlechte Kommentare

Veraltete Kommentare

Kommentare, die veraltet, veraltet, irrelevant sind oder falsche Informationen liefern. Kommentare können sehr schnell alt werden, weil sich die Codebasis jeden Tag ändern kann, die Technologie sich jeden Tag ändern kann.

Wie löst man:

Aktualisieren Sie es so schnell wie möglich
Eigentlich nur löschen

Falsche Grammatik, zu viele Markierungen, Murmeln, Ploppen sind einfach schlecht geschrieben. Laut sauberem Code ist ein Kommentar, der es wert ist, geschrieben zu werden, es wert, gut geschrieben zu werden. Wenn Sie einen schreiben, nehmen Sie sich Zeit, ihn zu verfeinern, und wählen Sie Ihre Worte sorgfältig aus.

Auskommentierter Code

Das ist die schlimmste Art von Kommentaren, sie machen mich jedes Mal verrückt, wenn ich einen Codeabschnitt sehe, der auskommentiert wurde. Dieser Code hat nichts bewirkt, sie saßen da und verfaulten. Aber niemand weiß, wann er es löschen soll, weil „vielleicht jemand es braucht“

Wie man es löst? Einfach löschen ! Heutzutage ist Git sehr wertvoll geworden, wir können es finden, wenn jemand es wirklich braucht

Redundante Kommentare

Diese sind auch schrecklich, schau dir das an:

for(let i = 0; i < 10; i++){
  a = b // assign a to b
}

// a function returns sum of a and b
function sum(a, b){ return a + b}

Löschen Sie sie einfach .

Laute Kommentare

Manche Kommentare sind einfach laut. Hast du jemals solche Kommentare gesehen?

// the name
private String name
// the version
private String version
// the constructor
constructor()

//The 123213 License
//
//Copyright (c)123213213213213, and Contributors
//
//Permission to use, copy, modify, and/or distribute this software for any
//purpose with or without fee is hereby granted, provided that the above
//copyright notice and this permission notice appear in all copies.
//
//THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
//WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
//MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
//ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
//WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
//ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
//IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

HTML-Kommentare

Dazu gibt es nicht viel zu sagen, ich glaube nicht, dass HTML-Kommentare überhaupt nützlich sind. Wir haben ID, Klassenname, Tag-Name und tausend weitere Möglichkeiten, die Bedeutung eines Codes zu bestimmen. Warum sich überhaupt die Mühe machen, Kommentare für sie zu schreiben?

Fazit

Obwohl einige Kommentare tatsächlich notwendig und nützlich sind, sind es die meisten Kommentare nicht. Ich weiß, dass dieser Artikel vielleicht nicht so positiv ist, aber ich möchte das nur begründen:

Wenn Ihr Code schlecht ist, kommentieren Sie ihn nicht, sondern bereinigen Sie ihn einfach

Im nächsten Artikel werde ich darüber schreiben, wie man gute Kommentare schreibt, bitte klicken Sie auf die Schaltfläche „Folgen“, um es in Zukunft zu überprüfen.