StyleAssistant-Homepage

34. Kommentare richtig auszeichnen (31.08.2000)

Da es immer wieder Probleme mit der Anwendung von Kommentaren in Web-Dokumenten gibt und vor allem das (von mir nicht verwendete!) Mailprogramm "Outlook Express" (oft als OjE bezeichnet) regelmäßig meine JavaScript-Kommentare respektlos verhackstückt und somit die Scripts unbrauchbar werden, hier einige Hinweise zum Kommentieren im Markup bzw. Script-Code.

1. (X)HTML-Kommentare:

	<!-- Das ist ein einzeiliger HTML-Kommentar. -->

	<!-- Das ist ein mehrzeiliger
	HTML-Kommentar. -->

	<!--
	Das ist ebenfalls ein
	mehrzeiliger
	HTML-Kommentar.
	-->

2. CSS-Kommentare:

Style Sheets werden in HTML-Kommentare verpackt, damit ältere Browser die Definitionen nicht im Klartext anzeigen. Buch- und Online-Publikationen verwenden nicht selten als Abschluss //-->, was immer wieder zu Irritationen führt.

	<STYLE TYPE="text/css">
	<!--

	/* Hier stehen die CSS-Definitionen. */

	-->
	</STYLE>

3. JavaScript-Kommentare:

	// Das ist ein einzeiliger JavaScript-Kommentar.

Ein- bzw. mehrzeilige JavaScript- aber auch CSS-Kommentare (siehe oben) werden in /* ... */ eingefügt.

	/* Einzeiliger JS- und CSS-Kommentar. */

	/* Mehrzeiliger
	JS- oder CSS-Kommentar. */

	/*
	Mehrzeilger JS-
	oder CSS-Kommentar.
	*/

Der JavaScript-Code wird ebenfalls zwischen HTML-Kommentaren abgelegt.

	<SCRIPT LANGUAGE="JavaScript" TYPE="text/javascript">
	<!--

	/* Hier steht der Script-Code. */

	//-->
	</SCRIPT>

Eine Besonderheit sind hier die beiden Schrägstriche vor dem schließenden HTML-Kommentar. Dieser JavaScript-Kommentar dient zur Abschottung der Zeichenfolge -- (minus minus) vom Script-Code. Das ist notwendig, da diese Zeichenfolge in JavaScript als sogenannter Dekrement-Operator fungiert (i-- ist die Kurzform von i=i-1) und somit evtl. auf den davor liegenden Script-Code einwirken könnte.
Das Mail- und Newsprogramm OjE ist der Meinung, aus //--> file://--> machen zu müssen, was natürlich den JavaScript-Code in E-Mails bzw. Newsgroup-Postings kaputt spielt. Als unmittelbare Folge ergeben sich oft Irritationen bei den Leser/inne/n, die dann nicht selten in patzige E-Mails münden ... :-((
Ein Workaround ist die Schreibweise mit Leerzeichen // --> oder einem trennenden Text in der Form // hier ist das JavaScript zu Ende -->. Allerdings ist es schon eine Zumutung, immer an diesen OjE zu denken, wenn man dieses Programm selbst gar nicht verwendet.

4. Kommentare in CDATA-Abschnitten:

In XML- und somit auch XHTML-Dokumenten werden Scripts und Style Sheets in CDATA-Abschnitten abgelegt bzw. besser als externe Dateien eingebunden.

	
	Script-Inhalte:
	
	<script language="JavaScript" type="text/javascript">
	<![CDATA[ 
	function Hallo()
	{
	alert("Hallo!");
	}
	]]>
	</script>
	
	Alternative (externe Datei):	
	<script language="JavaScript" src="dateiname.js"
	  type="text/javascript"></script> 
 	
	
	CSS-Definitionen:
	
	<style type="text/css"> 
	<![CDATA[ 
	h1
	{
	color: #FFFFFF;
	background-color: #FF0000;
	}
	]]>
	</style>
		
	Alternative (externe Datei):	
	<link rel="stylesheet" href="dateiname.css" type="text/css" />

5. VBScript-Kommentare:

Der in der Scriptsprache Visual Basic Script verfasste Code kann in Analogie zu JavaScript so auskommentiert werden (das Zeichen ' leitet einen einzeiligen Kommentar ein):

	'-->

Da es in VB aber den genannten Dekrement-Operator nicht gibt, kann auch ein einfacher HTML-Kommentar verwendet werden.

	<SCRIPT LANGUAGE="VBScript" TYPE="TEXT/VBSCRIPT">
	<!--

	' Hier steht der Script-Code.

	-->
	</SCRIPT>

Nach oben Zur Übersicht

Style

Assistant

Tipps & Tricks – Tipp 34 Zur Übersicht

Tipps & Tricks – Tipp 34
Zur Übersicht