Commit fbefc2f6 authored by Dr. Martin Goik's avatar Dr. Martin Goik

adding «mvn javadoc:javadoc» hint

parent 63c56583
...@@ -5,80 +5,86 @@ ...@@ -5,80 +5,86 @@
<title></title> <title></title>
</head> </head>
<body> <body><h1>Beschreibung</h1><p>In dieser Aufgabe sollen mehrere Methoden zur
<h1>Beschreibung</h1><p>In dieser Aufgabe sollen mehrere Methoden zur
Verarbeitung von Zeichenketten (Strings) implementiert Verarbeitung von Zeichenketten (Strings) implementiert
werden.</p><h1>Vorbereitung</h1><p>Importieren Sie <a href="/files/goik/Klausur/WS2014/cwerhfhasfcfzchefherbfer/sw1.zip">sw1.zip</a> als werden.</p><h1>Vorbereitung</h1><p>Importieren Sie <a
Maven Projekt in Ihren Eclipse workspace. Ignorieren Sie bitte das darin enthaltene href="/files/goik/Klausur/WS2014/cwerhfhasfcfzchefherbfer/sw1.zip">sw1.zip</a>
Package <code>de.hdm_stuttgart.mi.exam</code>.</p> als Maven Projekt in Ihre IDE. Ignorieren Sie bitte das darin enthaltene
Package <code>de.hdm_stuttgart.mi.exam</code>.</p>
<h1>Aufgabe</h1><p>Vervollständigen Sie die Implementierung der folgenden Methoden in der Klasse <h1>Aufgabe</h1><p>Vervollständigen Sie die Implementierung der folgenden
<code>de.hdm_stuttgart.sw1.klausur.stringlength.StringHelper</code>:</p><ol> Methoden in der Klasse
<code>de.hdm_stuttgart.sw1.klausur.stringlength.StringHelper</code>:</p><ol>
<li><code>int summierteWortLaenge(final String[] words)</code></li> <li><code>int summierteWortLaenge(final String[] words)</code></li>
<li><code>int anzahlZiffern(final String s)</code></li> <li><code>int anzahlZiffern(final String s)</code></li>
<li><code>int anzahlZiffern(final String strings[])</code></li> <li><code>int anzahlZiffern(final String strings[])</code></li>
<li><code>public static String[] filterUndSortiereDuplikate(final String[] inputStrings)</code></li>
<li><code>public static String[] filterUndSortiereDuplikate(final
String[] inputStrings)</code></li>
</ol><p>Die Javadoc Kommentare der jeweiligen Methoden beschreiben das </ol><p>Die Javadoc Kommentare der jeweiligen Methoden beschreiben das
gewünschte Verhalten.</p><h1>Allgemeine Hinweise</h1><ul> gewünschte Verhalten. Unter <a
href="https://freedocs.mi.hdm-stuttgart.de/__slidesd1GettingStarted.html#/sd1_fig_mavenJavadoc"
target="_blank">Maven javadoc:javadoc</a> finden Sie eine Anleitung zur
Umwandlung in das HTML Format zwecks besserer Lesbarkeit.</p><h1>Allgemeine
Hinweise</h1><ul>
<li><p>Für jede Methode aus der Klasse <code>StringHelper</code> steht <li><p>Für jede Methode aus der Klasse <code>StringHelper</code> steht
eine korrespondierende Junit Testklasse zur Verfügung:</p> eine korrespondierende Junit Testklasse zur Verfügung:</p> <table
<table style="border: 1px solid black;"> style="border: 1px solid black;">
<tr> <tr>
<td>Methode in <code>StringHelper</code></td> <td>Methode in <code>StringHelper</code></td>
<td>Korrespondierende Testklasse</td> <td>Korrespondierende Testklasse</td>
</tr> </tr>
<tr> <tr>
<td><hr/><code>int summierteWortLaenge(final String[] words)</code><p <td><hr /><code>int summierteWortLaenge(final String[]
style="color:red;">Das Array übergebener Worte kann null sein, words)</code><p style="color:red;">Das Array übergebener Worte
leer sein oder null Werte enthalten. Die Länge eines Strings kann null sein, leer sein oder null Werte enthalten. Die Länge
erhalten Sie über die Methode <code>int length()</code> aus der eines Strings erhalten Sie über die Methode <code>int
Klasse <code>java.lang.String</code>.</p></td> length()</code> aus der Klasse
<code>java.lang.String</code>.</p></td>
<td><hr/><code>TestSummierteWortlaenge</code></td> <td><hr /><code>TestSummierteWortlaenge</code></td>
</tr> </tr>
<tr> <tr>
<td><hr/><code>int anzahlZiffern(final String s)</code><p <td><hr /><code>int anzahlZiffern(final String s)</code><p
style="color:red;">Beachten Sie die Methode style="color:red;">Beachten Sie die Methode
<code><code>java.lang.Character.isDigit(char)</code></code>.</p></td> <code><code>java.lang.Character.isDigit(char)</code></code>.</p></td>
<td><hr/><code>TestAnzahlZiffernString</code></td> <td><hr /><code>TestAnzahlZiffernString</code></td>
</tr> </tr>
<tr> <tr>
<td><hr/><code>int anzahlZiffern(final String strings[])</code><p <td><hr /><code>int anzahlZiffern(final String strings[])</code><p
style="color:red;">Die Implementierung kann unter Verwendung der style="color:red;">Die Implementierung kann unter Verwendung der
Methode <code>int anzahlZiffern(final String s)</code> Methode <code>int anzahlZiffern(final String s)</code>
erfolgen.</p></td> erfolgen.</p></td>
<td><hr/><code>TestAnzahlZiffernStringArray</code></td>
</tr>
<tr>
<td><hr/><code>String[] filterUndSortiereDuplikate(final String[] inputStrings)</code><p
style="color:red;">Es gibt sehr verschiedene Lösungsansätze. Sie dürfen Instanzen von
<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html">List</a> oder
<a href="http://docs.oracle.com/javase/8/docs/api/java/util/SortedSet.html">SortedSet</a> verwenden.</p></td>
<td><hr/><code>TestFilterSortiere</code></td>
</tr>
</table></li>
<li><p>Beachten Sie alle Sonderfälle. Dazu zählen insbesondere <code><code>null</code></code> Werte <td><hr /><code>TestAnzahlZiffernStringArray</code></td>
übergebener Variablen oder enthaltene null Werte in übergebenen Arrays. Lesen Sie die </tr>
Beschreibung der einzelnen Methoden in den Kommentarköpfen <b>sehr genau</b>.</p></li>
</ul> <tr>
<td><hr /><code>String[] filterUndSortiereDuplikate(final String[]
<p>Sobald Sie die Aufgabe beendet haben, exportieren Sie Ihre Implementierung per Rechtclick auf das Eclipse Projekt über inputStrings)</code><p style="color:red;">Es gibt verschiedene
»Export-->General-->Archive file« und laden Sie die resultierende .zip Datei in das Ilias Klausursystem hoch. Lösungsansätze. Sie dürfen Instanzen von <a
Zur Kontrolle: Die hochgeladene .zip Datei muss im Klausursystem sichtbar sein.</p> href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html">List</a>
oder <a
</body> href="http://docs.oracle.com/javase/8/docs/api/java/util/SortedSet.html">SortedSet</a>
verwenden.</p></td>
<td><hr /><code>TestFilterSortiere</code></td>
</tr>
</table></li>
<li><p>Beachten Sie alle Sonderfälle. Dazu zählen insbesondere
<code><code>null</code></code> Werte übergebener Variablen oder
enthaltene null Werte in übergebenen Arrays. Lesen Sie die Beschreibung
der einzelnen Methoden in den Kommentarköpfen <b>sehr
genau</b>.</p></li>
</ul> <p>Sobald Sie die Aufgabe beendet haben, exportieren Sie Ihre
Implementierung per Rechtclick und laden Sie die resultierende .zip Datei in
das Ilias Klausursystem hoch. Zur Kontrolle: Die hochgeladene .zip Datei
muss im Klausursystem sichtbar sein.</p></body>
</html> </html>
...@@ -25,8 +25,12 @@ ...@@ -25,8 +25,12 @@
<li><code>morsen(final String input)</code></li> <li><code>morsen(final String input)</code></li>
</ol><p>Die Javadoc Kommentare der jeweiligen Methoden beschreiben das </ol><p>Die Javadoc Kommentare der jeweiligen Methoden beschreiben das
gewünschte Verhalten. Lesen Sie diese bitte <strong>sehr gewünschte Verhalten. Unter <a
genau</strong>.</p><h3>Allgemeine Hinweise</h3><ul> href="https://freedocs.mi.hdm-stuttgart.de/__slidesd1GettingStarted.html#/sd1_fig_mavenJavadoc"
target="_blank">Maven javadoc:javadoc</a> finden Sie eine Anleitung zur
Umwandlung in das HTML Format zwecks besserer Lesbarkeit.</p><p>Lesen Sie
die (generierte) Dokumentation <b>sehr genau</b>.</p><h3>Allgemeine
Hinweise</h3><ul>
<li><p>Erwägen Sie die Verwendung von <code><a <li><p>Erwägen Sie die Verwendung von <code><a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuffer.html" href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuffer.html"
target="_blank">StringBuffer</a></code> Instanzen.</p></li> target="_blank">StringBuffer</a></code> Instanzen.</p></li>
......
...@@ -33,16 +33,11 @@ ...@@ -33,16 +33,11 @@
implementieren.</p></li> implementieren.</p></li>
<li><p>Die Javadoc Kommentare der jeweiligen Methoden beschreiben das <li><p>Die Javadoc Kommentare der jeweiligen Methoden beschreiben das
gewünschte Verhalten. Als generierte HTML Dokumentation sind diese gewünschte Verhalten. Unter <a
besser lesbar. Klicken Sie zur Generierung in Eclipse auf »Project« / href="https://freedocs.mi.hdm-stuttgart.de/__slidesd1GettingStarted.html#/sd1_fig_mavenJavadoc"
»Generate Javadoc«. Wählen Sie dann ggf. noch Ihr Projekt aus und target="_blank">Maven javadoc:javadoc</a> finden Sie eine Anleitung zur
kopieren Sie die unter »Destination« aufgeführte Pfadangabe des Umwandlung in das HTML Format zwecks besserer Lesbarkeit.</p><p>Lesen
Generierungsordners (z.B. Sie die (generierte) Dokumentation <b>sehr genau</b>.</p></li>
<code>/home/klausur/examWorkspace/Exam/doc</code>). Nachdem Sie auf
»Finish« geklickt haben, können Sie diesen Pfad in die Adresszeile Ihres
Webbrowsers einfügen und die API Dokumentation Ihres Projekts
betrachten. </p><p>Lesen Sie diese Dokumentation <b>sehr
genau</b>.</p></li>
<li><p>Beachten Sie alle Sonderfälle. Dazu zählen insbesondere <li><p>Beachten Sie alle Sonderfälle. Dazu zählen insbesondere
<code><code>null</code></code> Werte übergebener Variablen oder <code><code>null</code></code> Werte übergebener Variablen oder
...@@ -54,9 +49,8 @@ ...@@ -54,9 +49,8 @@
</ul><h3 id="upload">Hochladen Ihrer Lösung in das </ul><h3 id="upload">Hochladen Ihrer Lösung in das
Klausursystem</h3><p>Sobald Sie die Aufgabe beendet haben (und möglichst Klausursystem</h3><p>Sobald Sie die Aufgabe beendet haben (und möglichst
alle Tests erfolgreich sind), exportieren Sie bitte Ihre Implementierung per alle Tests erfolgreich sind), exportieren Sie bitte Ihre Implementierung per
Rechtsklick im Package Explorer auf Ihr Eclipse Projekt. Sie können dann im Rechtsklick im Package Explorer. Sie können dann im Kontextmenü einen auf
Kontextmenü sukzessive »Export--&gt;General--&gt;Archive File« auswählen und <code>.zip</code> endenden Archivnamen festlegen. Laden Sie dieses
einen auf <code>.zip</code> endenden Archivnamen festlegen. Laden Sie dieses
<code>.zip</code> Archiv in das Ilias Klausursystem hoch (unteres <code>.zip</code> Archiv in das Ilias Klausursystem hoch (unteres
Seitenende). Zur Kontrolle: Die hochgeladene .zip Datei muss im Seitenende). Zur Kontrolle: Die hochgeladene .zip Datei muss im
Klausursystem sichtbar sein.</p><ul> Klausursystem sichtbar sein.</p><ul>
......
...@@ -13,19 +13,15 @@ ...@@ -13,19 +13,15 @@
Eclipse Projekts vorbereiteten Dummy Methoden.</p><h2>Allgemeine Eclipse Projekts vorbereiteten Dummy Methoden.</p><h2>Allgemeine
Hinweise</h2><ul> Hinweise</h2><ul>
<li><p>Die Javadoc Kommentare der jeweiligen Methoden beschreiben das <li><p>Die Javadoc Kommentare der jeweiligen Methoden beschreiben das
gewünschte Verhalten. Als generierte HTML Dokumentation sind diese gewünschte Verhalten. Unter <a
besser lesbar. Klicken Sie zur Generierung in Eclipse auf »Project« / href="https://freedocs.mi.hdm-stuttgart.de/__slidesd1GettingStarted.html#/sd1_fig_mavenJavadoc"
»Generate Javadoc«. Wählen Sie dann ggf. noch Ihr Projekt aus und target="_blank">Maven javadoc:javadoc</a> finden Sie eine Anleitung zur
kopieren Sie die unter »Destination« aufgeführte Pfadangabe des Umwandlung in das HTML Format zwecks besserer Lesbarkeit.</p><p>Lesen
Generierungsordners (z.B. Sie die (generierte) Dokumentation <b>sehr genau</b>.</p><p>Bei
<code>/home/klausur/examWorkspace/Exam/doc</code>). Nachdem Sie auf einzelnen Methoden finden Sie rot markierte, unverbindlicher Tips zur
»Finish« geklickt haben, können Sie diesen Pfad in die Adresszeile Ihres Implementierung. Sie können eine völlig andere Strategie der
Webbrowsers einfügen und die API Dokumentation Ihres Projekts Implementierung wählen, solange die zugehörigen JUnit Tests erfolgreich
betrachten. </p><p>Lesen Sie diese Dokumentation <b>sehr sind.</p></li>
genau</b>.</p><p>Bei einzelnen Methoden finden Sie rot markierte,
unverbindlicher Tips zur Implementierung. Sie können eine völlig andere
Strategie der Implementierung wählen, solange die zugehörigen JUnit
Tests erfolgreich sind.</p></li>
<li><p>Für jede Methode aus der Klasse <li><p>Für jede Methode aus der Klasse
<code>de.hdm_stuttgart.sw1.klausur.Helper</code> stehen Ihnen in der <code>de.hdm_stuttgart.sw1.klausur.Helper</code> stehen Ihnen in der
......
...@@ -41,11 +41,10 @@ ...@@ -41,11 +41,10 @@
<li><p>Die Javadoc Kommentare der jeweiligen Methoden beschreiben das <li><p>Die Javadoc Kommentare der jeweiligen Methoden beschreiben das
gewünschte Verhalten. Unter <a gewünschte Verhalten. Unter <a
href="https://freedocs.mi.hdm-stuttgart.de/webhelp/sd1SectMavenGenerateJavadoc.html" href="https://freedocs.mi.hdm-stuttgart.de/__slidesd1GettingStarted.html#/sd1_fig_mavenJavadoc"
target="_blank">Generating Javadoc™ project documentation</a> finden Sie target="_blank">Maven javadoc:javadoc</a> finden Sie eine Anleitung zur
eine Anleitung zur Umwandlung in das HTML Format zwecks besserer Umwandlung in das HTML Format zwecks besserer Lesbarkeit.</p><p>Lesen
Lesbarkeit.</p><p>Lesen Sie die (generierte) Dokumentation <b>sehr Sie die (generierte) Dokumentation <b>sehr genau</b>.</p></li>
genau</b>.</p></li>
<li><p>Beachten Sie alle Sonderfälle. Dazu zählen insbesondere <li><p>Beachten Sie alle Sonderfälle. Dazu zählen insbesondere
<code><code>null</code></code> Werte übergebener Variablen oder <code><code>null</code></code> Werte übergebener Variablen oder
......
...@@ -108,14 +108,22 @@ ...@@ -108,14 +108,22 @@
<listitem> <listitem>
<para>Die <productname>Javadoc</productname> Kommentare der <para>Die <productname>Javadoc</productname> Kommentare der
jeweiligen Methoden beschreiben das gewünschte Verhalten. Unter jeweiligen Methoden beschreiben das gewünschte Verhalten. Generieren
<link Sie aus diesen durch Aufruf im Projektverzeichnis HTML
xlink:href="https://freedocs.mi.hdm-stuttgart.de/sd1SectMavenGenerateJavadoc.html">Generating Dokumentation. Für den Nutzer <code>xy123</code> schaut dies
Javadoc™ project documentation</link> finden Sie eine Anleitung zur <abbrev>z.B.</abbrev> so aus:</para>
Umwandlung in das HTML Format zwecks besserer Lesbarkeit.</para>
<screen>cd ~/Downloads/Exam
<para>Lesen Sie die (generierte) Dokumentation <emphasis mvn javadoc:javadoc
role="bold">sehr genau</emphasis>.</para> ...
Generating <emphasis role="bold">/home/xy123/Downloads/Exam/target/site/apidocs/index.html</emphasis>...
Generating /home/xy123/Downloads/Exam/target/site/apidocs/overview-summary.html...
Generating /home/xy123/Downloads/Exam/Solve/target/site/apidocs/help-doc.html...</screen>
<para>Kopieren Sie Ihren der hervorgehobenen Zeile entsprechenden
Text in die Adresszeile Ihres <foreignphrase
xml:lang="en">Browsers</foreignphrase>. Lesen Sie die generierte
Dokumentation sehr genau.</para>
</listitem> </listitem>
<listitem> <listitem>
......
...@@ -130,14 +130,22 @@ ...@@ -130,14 +130,22 @@
<listitem> <listitem>
<para>Die <productname>Javadoc</productname> Kommentare der <para>Die <productname>Javadoc</productname> Kommentare der
jeweiligen Methoden beschreiben das gewünschte Verhalten. Mittels jeweiligen Methoden beschreiben das gewünschte Verhalten. Generieren
<option>Tools</option> --&gt; <option>Generate JavaDoc</option> Sie aus diesen durch Aufruf im Projektverzeichnis HTML
können Sie in IntelliJ unter Angabe eines Zielverzeichnisses aus den Dokumentation. Für den Nutzer <code>xy123</code> schaut dies
Javadoc Beschreibungen eine besser lesbare HTML Ausgabe <abbrev>z.B.</abbrev> so aus:</para>
erzeugen.</para>
<screen>cd ~/Downloads/Exam
<para>Lesen Sie die (generierte) Dokumentation <emphasis mvn javadoc:javadoc
role="bold">sehr genau</emphasis>.</para> ...
Generating <emphasis role="bold">/home/xy123/Downloads/Exam/target/site/apidocs/index.html</emphasis>...
Generating /home/xy123/Downloads/Exam/target/site/apidocs/overview-summary.html...
Generating /home/xy123/Downloads/Exam/Solve/target/site/apidocs/help-doc.html...</screen>
<para>Kopieren Sie Ihren der hervorgehobenen Zeile entsprechenden
Text in die Adresszeile Ihres <foreignphrase
xml:lang="en">Browsers</foreignphrase>. Lesen Sie die generierte
Dokumentation sehr genau.</para>
</listitem> </listitem>
<listitem> <listitem>
......
...@@ -72,14 +72,22 @@ ...@@ -72,14 +72,22 @@
<listitem> <listitem>
<para>Die <productname>Javadoc</productname> Kommentare der <para>Die <productname>Javadoc</productname> Kommentare der
jeweiligen Methoden beschreiben das gewünschte Verhalten. Mittels jeweiligen Methoden beschreiben das gewünschte Verhalten. Generieren
<option>Tools</option> --&gt; <option>Generate JavaDoc</option> Sie daraus durch folgenden Aufruf im Projektverzeichnis HTML
können Sie in IntelliJ unter Angabe eines Zielverzeichnisses aus den Dokumentation. Für den Nutzer <code>xy123</code> schaut dies
<acronym>Javadoc</acronym> Beschreibungen eine besser lesbare HTML <abbrev>z.B.</abbrev> so aus:</para>
Ausgabe erzeugen.</para>
<screen>cd ~/Downloads/Exam
<para>Lesen Sie die generierte Dokumentation <emphasis mvn javadoc:javadoc
role="bold">sehr genau</emphasis>.</para> ...
Generating <emphasis role="bold">/home/xy123/Downloads/Exam/target/site/apidocs/index.html</emphasis>...
Generating /home/xy123/Downloads/Exam/target/site/apidocs/overview-summary.html...
Generating /home/xy123/Downloads/Exam/Solve/target/site/apidocs/help-doc.html...</screen>
<para>Kopieren Sie Ihren der hervorgehobenen Zeile entsprechenden
Text in die Adresszeile Ihres <foreignphrase
xml:lang="en">Browsers</foreignphrase>. Lesen Sie die generierte
Dokumentation sehr genau.</para>
</listitem> </listitem>
<listitem> <listitem>
......
...@@ -93,14 +93,22 @@ ...@@ -93,14 +93,22 @@
<listitem> <listitem>
<para>Die <productname>Javadoc</productname> Kommentare der <para>Die <productname>Javadoc</productname> Kommentare der
jeweiligen Methoden beschreiben das gewünschte Verhalten. Mittels jeweiligen Methoden beschreiben das gewünschte Verhalten. Generieren
<option>Tools</option> --&gt; <option>Generate JavaDoc</option> Sie aus diesen durch Aufruf im Projektverzeichnis HTML
können Sie in IntelliJ unter Angabe eines Zielverzeichnisses aus den Dokumentation. Für den Nutzer <code>xy123</code> schaut dies
Javadoc Beschreibungen eine besser lesbare HTML Ausgabe <abbrev>z.B.</abbrev> so aus:</para>
erzeugen.</para>
<screen>cd ~/Downloads/Exam
<para>Lesen Sie die (generierte) Dokumentation <emphasis mvn javadoc:javadoc
role="bold">sehr genau</emphasis>.</para> ...
Generating <emphasis role="bold">/home/xy123/Downloads/Exam/target/site/apidocs/index.html</emphasis>...
Generating /home/xy123/Downloads/Exam/target/site/apidocs/overview-summary.html...
Generating /home/xy123/Downloads/Exam/Solve/target/site/apidocs/help-doc.html...</screen>
<para>Kopieren Sie Ihren der hervorgehobenen Zeile entsprechenden
Text in die Adresszeile Ihres <foreignphrase
xml:lang="en">Browsers</foreignphrase>. Lesen Sie die generierte
Dokumentation sehr genau.</para>
</listitem> </listitem>
<listitem> <listitem>
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment