Back to main Page

Lernjournal 07.09.2022

Was habe ich diese Woche gemacht?

• Funktion des Schaufensters
  Wir haben in der Klasse angeschaut, wofür das Schaufenster da ist und wie man es z.B. gestalten könnte. Dazu haben wir an einem Beispiel angeschaut, wie man es beispielsweise aufbauen könnte. Danach haben wir in der Klasse angeschaut, wie andere ihre Lernjournale strukturieren, um vielleicht noch ein paar Impulse zu bekommen, wie man es auch machen könnte. Nachher hatten wir noch Zeit, um an unseren Kompetzen zu arbeiten.
• Einführung in JavaDocs
  Wir hatten eine kurze Einführug zu JavaDocs. Dabei haben wir kurz angeschaut, was JavaDoc ist, warum man es braucht und wie man es anwenden kann. Beim JavaDoc handelt es sich um eine Möglichkeit Java Code zu dokumentieren. Durch JavaDoc kann man Code einfach und ohne grösseren Aufwand direkt im Sourcecode dokumentieren. Anschlissend kann diese Dcumentation automatisch zu html Code umgewandelt werden, der anschlissend online gestellt werden kann. Ein Beispiel dafür wäre z.B. die Documentation von java.lang.String diese sieht zwar visual nicht sonderlich schön aus, ist allerdings übersichtlich und einheitlich gestaltet.
  Um selber eine eigene JavaDoc für eine Klasse zu erstellen, muss man lediglich über die zu dokumentierende Methode einen sogennanten JavaDoc Kommentar schreiben. Dieser ist ganz einfach aufgebaut. Er sieht zuerst aus wie ein normaler mehrzeiliger Kommentar. Allerdings beginnt ein JavaDoc Kommentar mit 2 Sternen /** anschlissend kommt die Dokumentation und Annotation, um bestimmte Sachen wie der Author @author genauer zu beschreiben.

/**
 * Example Java Doc commentar for class Main
 * @author yannick
 * @version 1.0
 *
 */
public class Main{

}

Nachdem ich die ganzen Klassen documentiert habe, habe ich daraus ganz einfach eine Javadoc Website generiert. Dadurch habe ich jetzt eine übersichtlche Dokumentation bei derich mich nur um den Inhalt und nicht um das desing kümmern musste Documentation.

Reflexion

Ich denke, dass ich diese Woche gut vorangekommen bin. Ich konnte mehrere Kompetenzen im Schaufenster erledigen und habe auch sonst alles gut verstanden. Zudem hab ich in dieser Woche auch etwas früher damit angefangen, mein Lernjournal zu schreiben.

Ziele

Ich habe persönlich keine speziellen Ziele in der nächsten Woche für das Modul 320.

Kompetenzen

Ich habe in dieser Woche an den Kompetenzen C1G und C1F gearbeitet.