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

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

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

Um den Code zu kommentieren, müssen Sie Kommentare in den Code schreiben.

Um den Code auskommentieren zu können, müssen Sie einen Text-Spickzettel für Website-Entwickler hinterlassen, um ihnen zu helfen, schneller durch den Code zu navigieren. Der Kommentar im Code ist für den Benutzer unsichtbar.

Also, was bedeutet es, den Code zu kommentieren und warum wurde diese Möglichkeit erfunden? Sehen Sie sich Beispiele an, wie Sie den HTML-Code, php, css, JavaScript und .htaccess auskommentieren.

Achtung: Kommentare im Code für jede Programmiersprache sind anders vorgeschrieben. Wenn Sie bestimmten Regeln nicht folgen, funktioniert Ihr Code möglicherweise nicht.

Kommentare im HTML-Code

<!-- Для HTML -->

HTML (HyperText Markup Language) ist eine standardisierte Auszeichnungssprache für Dokumente im World Wide Web. Die meisten Webseiten enthalten eine Beschreibung des Markups in HTML (oder XHTML). Die HTML-Sprache wird von Browsern interpretiert; Der resultierende formatierte Text wird auf dem Bildschirm eines Computers oder mobilen Geräts angezeigt.

Im World Wide Web werden HTML-Seiten in der Regel über HTTP- oder HTTPS-Protokolle vom Browser als Klartext oder Verschlüsselung in Browser übertragen.

Beispiel mit Anwendung:

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

Kommentare in PHP-Code

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

PHP (Hypertext Preprocessor - "PHP: Hypertext Preprocessor", ursprünglich Personal Home Page Tools - "Werkzeuge zum Erstellen persönlicher Webseiten") ist eine universelle Skriptsprache, die häufig für die Entwicklung von Webanwendungen verwendet wird. Derzeit von der überwiegenden Mehrheit der Hosting-Provider 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 im Rahmen eines Open-Source-Projekts entwickelt. Das Projekt wird unter einer eigenen Lizenz vertrieben, die mit der GNU GPL nicht kompatibel ist.

Beispiel mit Anwendung:

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

Kommentare im CSS-Code

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

CSS (Englisch Cascading Style Sheets) ist eine formale Sprache zum Beschreiben der Darstellung eines Dokuments, das mit einer Auszeichnungssprache geschrieben wurde.

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

Beispiel mit Anwendung:

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

Kommentare im JavaScript-Code

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

JavaScript (abgekürzt JS) ist eine Multiparadigma-Programmiersprache. Unterstützt objektorientierte, imperative und funktionale Stile. Es ist die Implementierung der ECMAScript-Sprache (ECMA-262-Standard).

JavaScript wird häufig als eingebettete Sprache für den programmatischen Zugriff auf Anwendungsobjekte verwendet. Die breiteste Anwendung wird in Browsern als Skriptsprache gefunden, um Webseiten Interaktivität zu verleihen.

Beispiel mit Anwendung:

  <Skripttyp = "Text / Javascript">
 / * Zählzeit * /
 var RemainsSec = (parseInt (totalRemains / 1000));  // wie viele Sekunden sind noch übrig?
 var RemainsFullDays = (parseInt (RemainsSec / (24 * 60 * 60)));  // Tage übrig
 / * Ende des Countdowns * /
 </ script>

Kommentare im .htaccess-Code

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

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

Anweisungen für die .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 der UTF-8-Codierung speichern, sollte sie keine BOM-Signatur enthalten.

Beispiel mit Anwendung:

  # Schutz des Kommentars von Spam bot
 RewriteEngine Ein
 RewriteCond% {REQUEST_METHOD} POST

Über bloggood.ru & wiki

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

Wie schreibe ich Code sofort mit Kommentaren?

Tatsächlich wurde das TDD-Prinzip (Test-driven development, Entwicklung durch Tests) auf das folgende Niveau verschoben. Ich erinnere mich nicht, wie es im Original klang, aber im Wesentlichen "Beschreibe die Struktur der Code-Kommentare." Auf einem Beispiel (stark übertrieben, warum - unten) der Code des Programms, das zwei Zahlen hinzufügt, wird dieses Prinzip so aussehen:

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

  zurückgeben 0;
 }

Und nur wenn der Rahmen aus den Kommentaren vorbereitet wird, ist es notwendig, einen Code zu schreiben, der das implementiert, was durch die Kommentare beschrieben wird.

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

  zurückgeben 0;
 }

Wie oben erwähnt, ist dieses Prinzip ein modifiziertes Prinzip, ein bewährtes TDD. Es sollte klar sein, dass die Abweichung von den Kommentaren, im Gegensatz zu der Abweichung von der Logik der Tests, zu keinen ernsthaften Konsequenzen führen wird, nun, es sei denn, Sie müssen die Kommentare neu schreiben.

Wie man einen bestehenden Code kommentiert

Die Antwort auf diese Frage ist ganz einfach: Kommentieren Sie die Entitäten vom übergeordneten zum untergeordneten Code : class -> method -> code innerhalb der Methode (falls erforderlich) .

Es ist völlig logisch zu denken: was nicht zu kommentieren. Sie müssen nicht in zwei Fällen kommentieren (einer von ihnen erklärt, warum das obige Codebeispiel stark übertrieben war):

  • Absolut offensichtliche Dinge. Kommentare der Form // Initialisieren den Zähler mehr als ihre Abwesenheit
  • Der unverständliche Code wird ergänzt durch einen Kommentar vom Typ // nichts verstanden

Bezüglich des zweiten Punktes lohnt es sich, ein wenig zu erläutern und ein Beispiel zu geben: 100 Zeichen Assemblercode in C einfügen! Du schaust es dir an und schreibst einen Kommentar // Viele bukaf! Nyasilil

Danach sieht die Person, die nach Ihrer Entlassung zu Ihnen kam, diesen Kommentar und ... alles! Er wird nicht einmal versuchen, es zu verstehen, und diese Aufzeichnung wird auf diesem Stück Code stigmatisiert, bis er entfernt wird (entweder Code oder Kommentar).

Endlich

Abschließend kann ich sagen, dass die Kunst des Schreibens von Kommentaren ein integraler Bestandteil der Kunst des Programmierens ist, deshalb müssen Sie Kommentare schreiben, und wie pathetisch das klingen mag, aber es ist notwendig, qualitative Kommentare zu lernen.