Programmiertechnik 1 - AIN/1
Wintersemester 2025/2026

Einstieg: Kennenlernen der Programmierwerkzeuge

1. Legen Sie einen Ordner prog1-uebungen an. Dieser Ordner wird im weiteren Verlauf der Übungen als Arbeitsverzeichnis bezeichnet.

   Sie können das Arbeitsverzeichnis auf Ihrem Rechner anlegen, wo Sie möchten. Ein guter Platz ist aber auch der Fileserver des Rechenzentrums, Ihr sogenanntes Z-Laufwerk.

   Legen Sie im Arbeitsverzeichnis immer nur die Dateien und Unterordner an, die in den Aufgabenstellungen explizit verlangt sind. Verwenden Sie für andere Dateien einen Ordner außerhalb von prog1-uebungen, z.B. einen Ordner prog1-beispiele.

2. Laden Sie die Java-Archiv-Datei Einstieg.jar herunter und speichern Sie dieses Archiv im Arbeitsverzeichnis.
   Öffnen Sie ein Terminal im Arbeitsverzeichnis und entpacken Sie das Archiv mit dem foglenden Kommando:

     jar xf Einstieg.jar

   Nach dem Entpacken enthält Ihr Arbeitsverzeichnis prog1-uebungen\ die folgenden Dateien und Unterordner:

   Teilnahmeprotokoll.html, .pdf	im Semester laufend auszufüllen und bei den Abgaben der Aufgaben zu zeigen
   Lesezeichen.html	enthält Links, die Sie beim Programmieren brauchen
   build.xml	Hilfsdatei für das Werkzeug ant
   prog_checks.xml, suppressions.xml	Hilfsdateien für das Werkzeug checkstyle
   exclude_filter.xml	Hilfsdatei für das Werkzeug spotbugs
   einstieg\package-info.java	Paketverzeichnis mit Paketdokumentation

3. Starten Sie einen Texteditor, etwa VSCode oder notepad++, und geben Sie im Editor das folgend Java-Programm ein:

     // Einstieg.java
     package einstieg;
   
    import java.util.Scanner;
   
     /**
      * Einstieg ist ein kleines Java-Programm.
      * Es verwendet die Klassen Scanner und System aus der Java-Bibliothek.
      * @author TODO: hier Ihren Namen eintragen und TODO inklusive Doppelpunkt löschen
      * @version TODO: hier das aktuelle Datum eintragen und TODO inklusive Doppelpunkt löschen
      */
     public final class Einstieg {
         private Einstieg() { }
   
         private static final Scanner EINGABE = new Scanner(System.in);
   
         /**
          * Die Klassenmethode main ist der Startpunkt des Programms.
          * main verwendet die Methoden print und printf zum Ausgeben von Text
          * sowie die Methoden next und nextInt zum Einlesen von Text
          * und einer ganzen Zahl.
          * @param args wird nicht verwendet
          */
         public static void main(String[] args) {
             System.out.print("Vorname: ");
             String vorname = EINGABE.next();
   
             System.out.print("Anzahl bisher geschriebener Java-Programme: ");
             int anzahl = EINGABE.nextInt();
   
             System.out.printf("%ss %d. Java-Programm funktioniert!%n",
                               vorname, anzahl + 1);
         }
     }
   

   Beenden Sie den Editor und speichern Sie dabei Ihr Programm als Datei Einstieg.java im Unterordner prog1-uebungen\einstieg. Es ist wichtig den Dateinamen inklusive Groß-/Kleinschreibung sowie den Ordner genau einzuhalten. Der Ordner ist das Paketverzeichnis des Programms.
4. Öffnen Sie ein Terminal im Paketverzeichnis prog1-uebungen\einstieg und übersetzen Sie Ihr Programm mit dem Kommando:

     javac Einstieg.java

   Nach dem erfolgreichen Übersetzen enthält Ihr Paketverzeichnis die Datei Einstieg.class.

   Bei Fehlermeldungen müssen Sie die Tippfehler in Ihrem Programm korrigieren und dann erneut übersetzen.

5. Wechseln Sie im Terminal vom Paketverzeichnis in das Arbeitsverzeichnis mit dem Kommando

     cd  ..

   Starten Sie dann Ihr Programm mit dem Kommando

     java einstieg.Einstieg

   Das Programm fordert Sie auf, Ihren Vornamen sowie die Anzahl Ihrer bisher geschriebenen Java-Programme einzugeben, und gibt anschließend einen Text aus.
6. Bleiben Sie im Terminal im Arbeitsverzeichnis und prüfen Sie mit dem Analysewrkzeug checkstyle, ob Sie in Ihrem Programm Stilregeln verletzt haben. Starten Sie checkstyle über das Automatisierungswerkzeug ant mit dem Kommado

     ant -Dpackage=einstieg style

   Auf Ihrem eigenen Rechner müssen Sie die Datei build.xml angepasst haben, damit das funktioniert (siehe die Installationsanleitungen auf der Webseite der Lehrveranstaltung).

   Falls checkstyle Stilverletzungen meldet, müssen Sie Ihr Programm korrigieren und dann zu Schritt 4 zurück gehen.

7. Erzeugen Sie HTML-Dokumentation zu Ihrem Programm mit dem Kommando

     javadoc -html5 -encoding UTF-8 -d doc -author -version -linksource einstieg

   oder einfacher über das Automatisierungswerkzeug ant mit dem Kommado

     ant doc

   Öfnnen Sie Lesezeichen.html aus Ihrem Arbeitsverzeichnis im Browser und gehen Sie auf den Link doc/index.html. Betrachten Sie im Browser die erzeugte Dokumentation. Untersuchen Sie, welche Texte aus den .java-Dateien wo in den HTML-Seiten stehen.