Beispiele zu javadoc


Beispiele zum Aufruf



 
Befehl: javadoc ddformeln.java
Bedeutung: Die Quelle ddformeln.java im aktuellen Verzeichnis wird ausgewertet. Die erzeugten HTML-Dokumentationen liegen in demselben Verzeichnis.
Befehl: javadoc -author -version ddformeln.java
Bedeutung: Die Quelle ddformeln.java im aktuellen Verzeichnis wird ausgewertet unter Berücksichtigung des Autoren- und Versions-Tags.
Befehl: javadoc -author -version /home_s/dduck/prakt/ddformeln2.java
Bedeutung: Die Quelle ddformeln2.java im Unterverzeichnis /prakt/  wird ausgewertet unter Berücksichtigung des Autoren- und Versions-Tags. Die erzeugten HTML-Dateien liegen im aktuellen Verzeichnis.
Befehl: javadoc -author -version     /home_s/dduck/prakt/*.java    /home_s/dduck/tools/mat.java
Bedeutung: Sämtliche Quelldateien (vom Typ .java) des Unterverzeichnisses /prakt/  werden ausgewertet sowie die Quelle mat.java des Unterverzeichnisses /mat/. Autoren- und Versionstags werden berücksichtigt. Die erzeugte gemeinsame HTML-Dokumentation liegt im aktuellen Verzeichnis. 
Befehl: javadoc -author -version     /home_s/dduck/prakt/*.java    /home_s/dduck/tools/mat.java    -d  /home_s/dduck/docs
Bedeutung: Dieselben Quellen wie im obigen Befehl werden dokumentiert. Die erzeugte HTML-Dokumentation wird im Unterverzeichnis /docs/ abgelegt.
Befehl: javadoc -author -version     /home_s/dduck/prakt/*.java   DDTOOLS   -sourcepath /home_s/dduck/pakete -d  /home_s/dduck/docs    -header "Text für die Kopfzeile"
Bedeutung: Es werden sämtliche Java-Quelldateien des  Unterverzeichnisses /prakt/ sowie das benutzereigene Paket DDTOOLS. Das Paket ist im Unterverzeichnis /pakete/ der Benutzerin Daisy Duck anzutreffen. Die HTML-Dokumentation wird in die Unterdirectory /docs/ gelegt. Außerdem erscheint in der Dokumentaion auf jeder Seite als Kopfzeile der Text "Text für die Kopfzeile".


 
 
 
 
 

Beispiel : Java-Quelle ddformeln.java
mit javadoc-Dokumentationskommentaren für die Klasse ddformeln mit den Methoden fakr (Fakultätsberechnung) und fiboi (Berechnung von Fibonacci-Zahlen)


/* Dieser Kommentar wird von javadoc
   nicht ausgewertet.*/

/**
* Daisy Duck's mathematische Formelsammlung in Java
* @author Daisy Duck 
* @author Zeta de Termi-Nante
* @version 30.2.2002
*/

public class ddformeln
{
  public ddformeln()
  { 
  } 

// ***** FAKULTAET rekursiv ***************************************
//       Beispiel fuer elegante Rekursion 

/**
 * Berechnet n-Fakultät. 

 * Programmversion für Rekursion.
 * @param n natürliche Zahl zur Berechnung von n!
 * @return n!
 */

  public long fakr(int n)
  {
    if (n<0) return -1;
    else
       if (n==0) return 1;
       else return n*fakr(n-1);
  }

// ***** FIBONACCI iterativ ***************************************
/**
* Berechnet die n-te Fibonacci-Zahl 

* Programmversion für Iteration
* @param n wievielte Fibonacci-Zahl?
* @return n-te Fibonacci-Zahl
* @author Else Specht
*/
   public int fiboi(int n)
   { int fi =1;
     int h_1=1; int h_2=1;
     if(n<=0) return fi=-1;
       else 
         if (n==1 || n==2) return fi=1;
           else
             { 
               for (int i=3; i<n+1; i++)
               { 
                 fi=h_1 + h_2;
                 h_2=h_1;
                 h_1=fi;
               }
                return fi;
             }
   }
// ***** Ende
}


-->  zurück


(Sigrid Wehner / Mai 2002)