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 in Code zu schreiben.

Wenn Sie Code auskommentieren, müssen Sie ein Spickzettel für Website-Entwickler hinterlassen, damit diese schneller im Code navigieren können. Der Kommentar im Code ist für den Benutzer nicht sichtbar.

Was bedeutet es also, den Code zu kommentieren, und warum wurde diese Funktion erdacht? Schauen Sie sich Beispiele an, wie Sie HTML-Code, PHP, CSS, JavaScript und .htaccess auskommentieren können, um Ihnen alles klarer zu machen.

Achtung: Kommentare im Code für jede Programmiersprache sind anders 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 aus der Interpretation wird auf dem Monitor eines Computers oder Mobilgeräts angezeigt.

Im World Wide Web werden HTML-Seiten in der Regel vom Server über HTTP- oder HTTPS-Protokolle im Nur-Text- oder Verschlüsselungsmodus an Browser übermittelt.

Beispiel mit:

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

PHP-Code-Kommentare

/* 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 Skriptsprache für allgemeine Zwecke, die häufig zur Entwicklung von Webanwendungen verwendet wird. Derzeit wird die überwiegende Mehrheit der Hosting-Anbieter unterstützt und gehört zu den führenden Sprachen bei der Erstellung dynamischer Websites.

Die Sprache und ihr Interpreter (Zend Engine) werden von einer Gruppe Enthusiasten in einem Open Source-Projekt entwickelt. Das Projekt wird unter einer 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 (engl. Cascading Style Sheets - Cascading Style Sheets) ist eine formale Sprache, die das Erscheinungsbild eines Dokuments beschreibt, das mit einer Auszeichnungssprache geschrieben wurde.

Es wird hauptsächlich zum Beschreiben und Gestalten des Erscheinungsbildes von Webseiten verwendet, die mit HTML- und XHTML-Markup-Sprachen geschrieben wurden, kann aber auch auf beliebige XML-Dokumente angewendet werden, z. B. SVG oder XUL.

Beispiel mit:

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

JavaScript-Code-Kommentare

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

JavaScript (kurz: Js) ist eine Programmiersprache mit mehreren Paradigmen. Unterstützt objektorientierte, imperative und funktionale Stile. Es ist eine Implementierung von ECMAScript (ECMA-262-Standard).

JavaScript wird normalerweise als eingebettete Sprache für den programmgesteuerten Zugriff auf Anwendungsobjekte verwendet. Wird in Browsern am häufigsten als Skriptsprache verwendet, um Interaktivität mit Webseiten zu erzielen.

Beispiel mit:

  <script type = "text / javascript">
 / * Countdown * /
 var RemainsSec = (parseInt (totalRemains / 1000));  // wie viele Sekunden sind noch übrig?
 var RemainsFullDays = (parseInt (RemainsSec / (24 * 60 * 60)));  // Tage übrig
 / * Das Ende des Countdowns * /
 </ script>

Kommentare im Code ".htaccess"

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

.htaccess ist eine Konfigurationsdatei des Apache-Webservers, mit der Sie den Webservervorgang und die Websiteeinstellungen mit verschiedenen Parametern (Anweisungen) verwalten können, ohne die Hauptkonfigurationsdatei des Webservers zu ändern.

Die Direktiven der .htaccess-Datei gelten für das Verzeichnis, in dem sich eine solche Datei befindet, sowie für alle ihre Unterverzeichnisse. Seien Sie beim Bearbeiten der .htaccess-Datei vorsichtig! Wenn Sie eine solche Datei in UTF-8-Codierung speichern, sollte sie keine Stücklistensignaturen enthalten.

Beispiel mit:

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

Über bloggood.ru & wiki

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

Wie schreibe ich Code sofort mit Kommentaren?

Im Wesentlichen wurde das TDD-Prinzip (Test-Driven Development, Development Through Testing) auf ein niedrigeres Niveau verschoben. Ich erinnere mich nicht, wie es im Original klang, sondern „Beschreibe die Struktur des Codes mit Kommentaren“. Am Beispiel von (stark übertriebenem Warum - unten) Programmcode, der zwei Zahlen hinzufügt, sieht dieses Prinzip folgendermaßen aus:

  int main ()
 {
  // Akzeptiere zwei Nummern vom Benutzer
  // Eine Variable für das Ergebnis der Addition erstellen
  // Das Ergebnis der Addition zurückgeben

  0 zurückgeben;
 }

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

  ...
 int main ()
 {
  doppelt a, b;
  // Akzeptiere zwei Nummern vom Benutzer
  cin >> a;
  cin >> b;
  // Eine Variable für das Ergebnis der Addition erstellen
  Doppelsumme = a + b;
  // Das Ergebnis der Addition zurückgeben
  cout << summe;

  0 zurückgeben;
 }

Wie oben erwähnt, handelt es sich bei diesem Prinzip um ein modifiziertes, bewährtes TDD. Hier ist zu verstehen, dass Abweichungen von den Kommentaren im Gegensatz zu den Abweichungen von der Logik der Tests nicht zu schwerwiegenden Folgen führen, 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 Elternteil zu Kind: Klasse -> Methode -> Code innerhalb der Methode (falls erforderlich) .

Es ist logisch zu denken: Was muss man nicht kommentieren? In zwei Fällen besteht keine Notwendigkeit zu kommentieren (einer von ihnen erklärt, warum das obige Codebeispiel stark übertrieben war):

  • Sehr offensichtliche Dinge. Kommentare des Formulars // Wir initialisieren den Gegenangriff mehr als ihre Abwesenheit
  • Unverständlicher Code Kommentar-Typ hinzufügen // nicht verstanden

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

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

Zum Schluss

Zusammenfassend kann ich sagen, dass die Kunst, Kommentare zu schreiben, ein integraler Bestandteil der Programmierkunst ist, also müssen Kommentare geschrieben werden und so pathetisch es auch klingen mag, aber man muss lernen, qualitativ hochwertige Kommentare zu schreiben.