This page has been robot translated, sorry for typos if any. Original content here.

Wie kann man Code in HTML, PHP, JavaScript, CSS, .htaccess auskommentieren?

Как закомментировать код

Code auskommentieren bedeutet, Kommentare im Code zu schreiben.

Code auskommentieren bedeutet, dass ein Spickzettel für Website-Entwickler erstellt wird, der ihnen hilft, den Code schneller zu navigieren. Der Kommentar im Code ist für den Benutzer unsichtbar.

Also, was bedeutet es, den Code zu kommentieren, und warum wurde dieses Feature ausgedacht? Damit Ihnen jetzt alles klar wird, schauen Sie sich Beispiele zum Auskommentieren von HTML-Code, PHP, CSS, JavaScript und .htaccess an.

Achtung: Kommentare im Code für jede Programmiersprache sind unterschiedlich geschrieben. Wenn Sie sich nicht an bestimmte Regeln halten, funktioniert Ihr Code möglicherweise nicht.

HTML-Code Kommentare

<!-- Для HTML -->

HTML (aus dem Englischen. HyperText Markup Language - "Hypertext Markup Language") ist eine standardisierte Auszeichnungssprache für Dokumente im World Wide Web. Die meisten Webseiten enthalten HTML (oder XHTML) Markup. HTML wird von Browsern interpretiert; formatierter Text, der sich aus der Interpretation ergibt, wird auf dem Bildschirm eines Computers oder mobilen Geräts angezeigt.

Im World Wide Web werden HTML-Seiten vom HTTP- oder HTTPS-Protokoll des Browsers in der Regel in Browsern im Klartext oder mit Verschlüsselung übertragen.

Beispiel mit:

  <html>
 <Kopf>
 <title> Kommentare im HTML-Code </ title>
 </ Kopf>
 <Körper>
 <! - Sitecap ->
 <img src = "kartinka.png">
 <! - Ende des Site-Headers ->
 </ body>
 </ html>

Kommentare in PHP-Code

/* 1. Многострочный комментарий для PHP */ // 2. Однострочный комментарий для PHP # 3. Однострочный комментарий для PHP

PHP (PHP: Hypertext Preprocessor - "PHP: Hypertext Preprocessor"; ursprünglich Personal Home Page Tools - "Werkzeuge zum Erstellen persönlicher Webseiten") ist eine allgemeine Skriptsprache, die häufig für die Entwicklung von Webanwendungen verwendet wird. Derzeit von der überwältigenden Mehrheit der Hosting-Anbieter unterstützt und ist eine der führenden unter den Sprachen, die verwendet werden, um dynamische Websites zu erstellen.

Die Sprache und ihr Interpreter (Zend Engine) werden von einer Gruppe von Enthusiasten in einem Open-Source-Projekt entwickelt. Das Projekt wird unter seiner eigenen Lizenz vertrieben, die mit der GNU GPL nicht kompatibel ist.

Beispiel mit:

  <? php
 / * 1. Mehrzeiliger Kommentar für PHP * /
 echo "Beispiel 1";  // 2. Einzeiliger Kommentar für PHP
 echo "Beispiel 2";  # 3. Einzeiliger Kommentar für PHP
 ?>

Kommentare im CSS-Code

/* комментарий в css */

CSS (Englisch Cascading Style Sheets - Cascading Style Sheets) ist eine formale Sprache, die das Aussehen eines Dokuments beschreibt, das mit einer Auszeichnungssprache geschrieben wurde.

Es wird hauptsächlich verwendet, um das Aussehen von Webseiten zu beschreiben, die mit HTML- und XHTML-Markup-Sprachen geschrieben wurden, kann aber auch auf beliebige XML-Dokumente angewendet werden, zum Beispiel SVG oder XUL.

Beispiel mit:

  .p
 {
 Schriftart: 25px "Times New Roman", Times, Serifen;  / * Schriftart und -größe * /
 }

JavaScript-Code Kommentare

// Однострочный комментарий для JavaScript /* Многострочный комментарий для JavaScript */

JavaScript (Abk. Js) ist eine Multi-Paradigma-Programmiersprache. Unterstützt objektorientierte, imperative und funktionale Stile. Es ist eine Implementierung der ECMAScript-Sprache (ECMA-262-Standard).

JavaScript wird normalerweise als einbettbare Sprache für den programmgesteuerten Zugriff auf Anwendungsobjekte verwendet. Die am häufigsten in Browsern verwendete Skriptsprache, um die Interaktivität von Webseiten zu ermöglichen.

Beispiel mit:

  <Skripttyp = "Text / Javascript">
 / * Countdown * /
 var RemainsSec = (parseInt (totalRemains / 1000));  // wie viele Sekunden sind noch übrig?
 var RemainsFullDays = (parseInt (RemainsSec / (24 * 60 * 60)));  // Tage übrig
 / * Ende der Zeit Countdown * /
 </ script>

Kommentare im ".htaccess" -Code

# Описание инструкции

.htaccess ist eine Apache-Webserver-Konfigurationsdatei, mit der Sie die Webserver-Betriebs- und Standorteinstellungen mithilfe verschiedener Parameter (Direktiven) verwalten können, ohne die Hauptkonfigurationsdatei des Webservers zu ändern.

Die Anweisungen der .htaccess-Datei gelten für das Verzeichnis, in dem sich die Datei befindet, und für alle Unterverzeichnisse. Bitte seien Sie vorsichtig beim Editieren der .htaccess Datei! Wenn Sie eine solche Datei in UTF-8-Kodierung speichern, sollte sie keine BOM-Signaturen enthalten.

Beispiel mit:

  # Kommentar Spam Bots Schutz
 RewriteEngine Ein
 RewriteCond% {REQUEST_METHOD} POST

Über bloggood.ru & wiki

Как закомментировать код

Wie schreibe ich Code sofort mit Kommentaren?

Im Wesentlichen wurde das TDD-Prinzip (Test-driven development, Entwicklung durch Testing) auf ein niedrigeres Niveau verschoben. Ich erinnere mich nicht, wie es im Original klang, aber tatsächlich "Beschreibe die Struktur des Codes mit Kommentaren". Zum Beispiel (stark übertrieben, warum - unten) des Programmcodes, der zwei Zahlen hinzufügt, wird dieses Prinzip so aussehen:

  int Haupt ()
 {
  // Empfange zwei Nummern vom Benutzer
  // Erzeuge eine Variable für das Ergebnis der Addition
  // Gib das Ergebnis der Addition zurück

  zurückgeben 0;
 }

Und nur wenn das Skelett der Kommentare fertig ist, sollten Sie Code schreiben, der das implementiert, was durch Kommentare beschrieben wird.

  ...
 int Haupt ()
 {
  Doppel a, b;
  // Empfange zwei Nummern vom Benutzer
  cin >> a;
  cin >> b;
  // Erzeuge eine Variable für das Ergebnis der Addition
  Doppelsumme = a + b;
  // Gib das Ergebnis der Addition zurück
  cout << Summe;

  zurückgeben 0;
 }

Wie oben erwähnt, ist dieses Prinzip ein modifiziertes, bewährtes TDD-Prinzip. Hier sollte verstanden werden, dass Abweichungen von den Kommentaren, im Gegensatz zu Abweichungen von der Logik der Tests, nicht zu ernsthaften Konsequenzen führen werden, nun, es sei denn, Sie müssen die Kommentare neu schreiben.

So kommentieren Sie bereits vorhandenen Code

Die Antwort auf diese Frage ist ziemlich einfach: Wir kommentieren Entitäten von Eltern zu Kind: Klasse -> Methode -> Code innerhalb der Methode (falls erforderlich) .

Es ist logisch zu denken: Was ist nicht nötig, um zu kommentieren. Es gibt keine Notwendigkeit, in zwei Fällen zu kommentieren (einer von ihnen erklärt, warum das obige Codebeispiel stark übertrieben war):

  • Sehr offensichtliche Dinge. Kommentare der Form // initialisieren wir die Gegenerregung mehr als ihre Abwesenheit
  • Unverständlicher Code Kommentar-Typ // nicht verstanden

In Bezug auf den zweiten Punkt, es lohnt sich, ein wenig zu erklären und ein Beispiel zu geben: 100 Zeilen Assembler-Code in C einfügen! Du schaust sie an und schreibst einen Kommentar // Viele Bücher! Niasilil

Danach sieht die Person, die nach Ihrer Entlassung zu Ihnen kam, diesen Kommentar und ... alles! Er wird nicht einmal versuchen, es herauszufinden, und dieser Eintrag wird ein Stigma für dieses Stück Code sein, bis es entfernt wird (entweder ein Code oder ein Kommentar).

Endlich

Zusammenfassend kann ich sagen, dass die Kunst des Schreibens von Kommentaren ein integraler Bestandteil der Kunst des Programmierens ist, also Kommentare geschrieben werden müssen, und so pathetisch es klingen mag, aber Sie müssen lernen, wie man qualitativ hochwertige Kommentare schreibt.