<?xml version="1.0" encoding="UTF-8"?>
<rss version="2.0"
	xmlns:content="http://purl.org/rss/1.0/modules/content/"
	xmlns:wfw="http://wellformedweb.org/CommentAPI/"
	xmlns:dc="http://purl.org/dc/elements/1.1/"
	xmlns:atom="http://www.w3.org/2005/Atom"
	xmlns:sy="http://purl.org/rss/1.0/modules/syndication/"
	xmlns:slash="http://purl.org/rss/1.0/modules/slash/"
	>

<channel>
	<title>Coder-Blog &#187; javadoc</title>
	<atom:link href="http://coder-blog.de/tag/javadoc/feed/" rel="self" type="application/rss+xml" />
	<link>http://coder-blog.de</link>
	<description>Computer, Informatik, Internet und Programmieren</description>
	<lastBuildDate>Wed, 23 Sep 2009 09:25:47 +0000</lastBuildDate>
	<generator>http://wordpress.org/?v=2.8</generator>
	<language>en</language>
	<sy:updatePeriod>hourly</sy:updatePeriod>
	<sy:updateFrequency>1</sy:updateFrequency>
			<item>
		<title>Java-Tutorial: Kommentare</title>
		<link>http://coder-blog.de/java-tutorial-kommentare/</link>
		<comments>http://coder-blog.de/java-tutorial-kommentare/#comments</comments>
		<pubDate>Sun, 29 Mar 2009 23:00:06 +0000</pubDate>
		<dc:creator>Eugen</dc:creator>
				<category><![CDATA[Java-Tutorials]]></category>
		<category><![CDATA[Blockkommentar]]></category>
		<category><![CDATA[informatik]]></category>
		<category><![CDATA[java-lernen]]></category>
		<category><![CDATA[java-tutorial]]></category>
		<category><![CDATA[javadoc]]></category>
		<category><![CDATA[JavaDoc-Kommentar]]></category>
		<category><![CDATA[Kommentare]]></category>
		<category><![CDATA[oop programmierung]]></category>
		<category><![CDATA[programmiersprache java]]></category>
		<category><![CDATA[uni-informatik]]></category>
		<category><![CDATA[Zeilenkommentar]]></category>

		<guid isPermaLink="false">http://coder-blog.de/?p=121</guid>
		<description><![CDATA[Java-Tutorial zu den verschiedenen Kommentaren, die in der Programmiersprache Java zur Verfügung stehen.]]></description>
			<content:encoded><![CDATA[<p>Als <strong>Kommentare</strong> bezeichnet man in Programmiersprachen besondere Code-Teile, die vom Compiler nicht in Maschinencode – in <strong>Java Bytecode</strong> – übersetzt werden, sondern nur den Lesern beziehungsweise den Programmierern dienen.<br />
Neben <strong>selbst sprechenden Namen</strong> für Variablen, Klassen und Methoden, sollte man Kommentare verwenden, um bestimmte Stücke des Quellcodes zu dokumentieren. Damit erleichtert man zum Einen anderen Entwicklern zu verstehen was ein Codefragment macht und zum anderen ist man dadurch in der Lage auch ein Programm zu verstehen, das man zum letzten mal vor einigen Monaten angesehen hat.<br />
Auch benutzt man Kommentare, um Anmerkungen &#8211; wie TODOs &#8211; festzuhalten, die einem während dem Programmieren auffallen.</p>
<p>Java bietet uns drei Möglichkeiten von Kommentaren:</p>
<ul>
<li> <strong>Zeilenkommentar</strong></li>
<li><strong> Blockkommentar</strong></li>
<li><strong> JavaDoc-Kommentar</strong></li>
</ul>
<p>Ein <strong>Zeilenkommentar</strong> gilt nur für eine Zeile und wird mit einem // eingeleitet. Möchte man Kommentare über mehrere Zeilen hinweg setzten, so bietet sich das <strong>Blockkommentar</strong> dafür an. Dieses wird mit einem /* eingeleitet und endet mit */.<br />
Das <strong>JavaDoc-Kommentar</strong> ist ein besonderes Blockkommentar, das zum Beispiel Beschreibungen von Funktionen  und / oder deren Parameter enthält. Beginnt man ein Kommentar mit /** und schließt es mit */ ab, handelt es sich um diesen Typ von Kommentar. Mit dem im JDK mitgelieferten Tool <strong>javadoc</strong> ist es möglich diese Kommentare zu einer <strong>API-Dokumentation</strong> zu generieren.<span id="more-121"></span></p>
<p>Mit Kommentaren können wir Code auch zum Testen und zur Fehlersuche auskommentieren, um diese vor dem Compiler zu verstecken.</p>
<p>Dieses Beispiel soll uns die Verwendung von Kommentaren in Java verdeutlichen:</p>

<div class="wp_syntax"><div class="code"><pre class="java" style="font-family:monospace;"><span style="color: #008000; font-style: italic; font-weight: bold;">/**
 * @author eugen
 * @version 1.0
 */</span>
<span style="color: #000000; font-weight: bold;">class</span> RasenMaehen
<span style="color: #009900;">&#123;</span>
  <span style="color: #666666; font-style: italic;">/*
  * Dieses Programm berechnet, ob man seinen Rasen mähen sollte
  */</span>
  <span style="color: #000000; font-weight: bold;">public</span> <span style="color: #000000; font-weight: bold;">static</span> <span style="color: #000066; font-weight: bold;">void</span> main <span style="color: #009900;">&#40;</span> <span style="color: #003399;">String</span><span style="color: #009900;">&#91;</span><span style="color: #009900;">&#93;</span> args <span style="color: #009900;">&#41;</span>
  <span style="color: #009900;">&#123;</span>
    <span style="color: #666666; font-style: italic;">//Maße in cm</span>
    <span style="color: #000066; font-weight: bold;">int</span> aktuelleLaenge <span style="color: #339933;">=</span> <span style="color: #cc66cc;">53</span><span style="color: #339933;">;</span>
    <span style="color: #000066; font-weight: bold;">int</span> gewuenschteLaenge <span style="color: #339933;">=</span> <span style="color: #cc66cc;">20</span><span style="color: #339933;">;</span>
    <span style="color: #000066; font-weight: bold;">int</span> maxUeberschuss <span style="color: #339933;">=</span> <span style="color: #cc66cc;">10</span><span style="color: #339933;">;</span>
&nbsp;
    <span style="color: #666666; font-style: italic;">// Wenn Ueberschuss zu groß, muss gemaeht werden</span>
    <span style="color: #000000; font-weight: bold;">if</span><span style="color: #009900;">&#40;</span> <span style="color: #009900;">&#40;</span>aktuelleLaenge – gewuenschteLaenge<span style="color: #009900;">&#41;</span> <span style="color: #339933;">&gt;</span> maxUeberschuss <span style="color: #009900;">&#41;</span>
    <span style="color: #009900;">&#123;</span>
      <span style="color: #003399;">System</span>.<span style="color: #006633;">out</span>.<span style="color: #006633;">println</span><span style="color: #009900;">&#40;</span><span style="color: #0000ff;">&quot;Rasen muss gemaeht werden&quot;</span><span style="color: #009900;">&#41;</span><span style="color: #339933;">;</span>
    <span style="color: #009900;">&#125;</span>
    <span style="color: #000000; font-weight: bold;">else</span>
    <span style="color: #009900;">&#123;</span>
      <span style="color: #003399;">System</span>.<span style="color: #006633;">out</span>.<span style="color: #006633;">println</span><span style="color: #009900;">&#40;</span><span style="color: #0000ff;">&quot;Geht noch!&quot;</span><span style="color: #009900;">&#41;</span><span style="color: #339933;">;</span>
    <span style="color: #009900;">&#125;</span>
  <span style="color: #009900;">&#125;</span>
<span style="color: #009900;">&#125;</span></pre></div></div>

<p>Bei dem ersten Kommentar handelt es sich um einen <strong>JavaDoc-Kommentar</strong>, der besondere Schlüsselwörter wie @author enthält, die vom <strong>javadoc-Tool</strong> ausgewertet werden können.<br />
Der zweite Kommentar auf den wir stoßen ist ein <strong>Blockkommentar</strong>, der sich über drei Zeilen hinzieht.<br />
Bei dem dritten und vierten Kommentar verwenden wir nun den <strong>Zeilenkommentar</strong>, der wie gesagt nur eine Zeile auskommentiert.</p>
]]></content:encoded>
			<wfw:commentRss>http://coder-blog.de/java-tutorial-kommentare/feed/</wfw:commentRss>
		<slash:comments>0</slash:comments>
		</item>
	</channel>
</rss>
