Decker Workshop

Folienerstellung - Kommentare

Sebastian Lukas Hauer

Lehrstuhl für Computergraphik, TU Dortmund

🚀 by Decker

Was sind Kommentare?

Kommentare sind Anmerkungen im Quelltext der Folien, die keinen Einfluss auf das Resultat haben und nur für den Entwickler der Folien bzw. den Leser des Quelltextes bestimmt sind.

Markdown besitzt an sich keine Syntax, die Kommentare auszeichnet.

Es gibt jedoch trotzdem zwei Möglichkeiten Text so zu markieren, dass er keinen Einfluss auf die generierten Folien hat.

Kommentare werden meistens dazu benutzt, um Text zu entfernen ohne ihn vollständig aus den Quelldaten zu löschen oder um den Quelltext selbst zu beschreiben.

HTML-Kommentare

Sie können Textfragmente mit <!-- und --> umgeben, um sie als HTML-Kommentare zu deklarieren. Diese werden zwar mit in die übersetzten Folien übernommen, besitzen aber keine Darstellung und sind damit auf den Folien praktisch nicht sichtbar. HTML-Kommentare können jedoch durch Untersuchen des Seitenquellcodes der Folien gelesen werden.

Beispiel: HTML-Kommentare

Dieser Text ist Teil der Folien.

<!--
Dieser Text wird nicht angezeigt.
Er kann auch über mehrere Zeilen hinweg gehen.
-->

Dieser Text ist erneut Teil der Folien
Beispielquellcode. Er soll deutlich machen, dass der auskommentierte Teil im folgenden nicht sichtbar ist. Sie können den Text rechtsklicken und im Browser untersuchen. Der auskommentierte Abschnitt sollte im Quelltext der Webseite aufzufinden sein.

Dieser Text ist Teil der Folien.

Dieser Text ist erneut Teil der Folien