Mit Javadoc arbeiten

[Guest]

hierzu habe ich folgende Seite im Netz gefunden:

http://homepages.fh-giessen.de/~hg7132/PIS/Uebungen/javadoc_tutorial.html

Meine Frage: in welchem Verzeichnis muss ich meine java-dateien haben? Ist das egal? Irgendwie bekomme ich das nicht hin und erhalte ständig Fehlermeldungen.

 

[maki]

Meine Frage: in welchem Verzeichnis muss ich meine java-dateien haben?

Falsche Frage, deine Quellen liegen dort wo sie eben liegen, solltest halt javadoc von dort aus starten.

 

[Guest]

ok aber genau das klappt nicht, ich versuche mit

 javadoc *.java

zu starten und bekomme Fehlermeldungen

 

[Guest]

Ich muss nochmal nachhaken, ich bekomme das mit dem Javadoc nicht hin. Ich bekomme immer die Meldung, dass Javadoc entweder falsch geschrieben oder nicht gefunden werden konnte.

Kann mir vielleicht mal jemand ein triviales beispiel hier aufschrieben, z.B. für eine Dokumentation für eine Java Klasse, die test.java heisst.

Ich verstehe nicht , wehsalb ich das nciht hinbekommen habe, eigentlich erscheint die Sache doch ganz einfach...

 

[maki]

>> Ich bekomme immer die Meldung, dass Javadoc entweder falsch geschrieben oder nicht gefunden werden konnte.

javadoc.exe muss im PATH sein.

 

[Final_Striker]

z.B:

D:\Programme\Java\jdk1.6.0_06\bin\javadoc.exe C:\test.java


den Pfad wo die javadoc.exe liegt musst du natürlich anpassen. :wink:

 

[Guest]

Könnt ihr mir noch rasch erklären, wie ich authortags und versiontags beim Aufruf von javadoc verarbeiten kann? Mir werden diese nämlich in meiner erzeugten html version nicht angezeigt

 

[X5-599]

hi,

wie meinst du das mit "verarbeiten" der tags beim aufruf von javadoc? wenn du diese tags in deinem sourcecode eingebaut hast, sollten sie auch im erzeugten .html file zu sehen sein...

also ich kenne zumindest nur diese art von authortag/versiontag. und die stehen (wie die anderen tags auch) im sourcecode.

z.b. so:

/**
 * The is the Hello World program.
 * It does nothing special.
 * 
 * @author InsertNameHere
 * @version 1.0
 */
public class HelloWorld
{
	private String message;
	
	public HelloWorld(String message)
	{
		this.message = message;
	}
	
	public void greetTheWorld()
	{
		System.out.println(message);
	}
	
	
	public static void main(String[] args)
	{
		HelloWorld helloworld = new HelloWorld("Hello World");
		helloworld.greetTheWorld();
	}
}

 

[Guest]

jo genau das meinte ich, aber die versionstags und authortags werden von meinem javdoc ignoriert. Es wird lediglich das sincetag ausgegeben ???:L

 

[SchonWiederFred]

Zeig uns doch mal Deinen Quelltext.

 

[Guest]

package Application;

import hilfen.Tastatur;
import Security.*;
import Output.*;

/**
 * Die KlasseApplicationStart wird zum Starten des Programms benötigt.
 * @author Max Mustermann
 * @since 1.0
 * @version 1.0
 */

public class ApplicationStart {
     
     /**
      * Die Methode main startet den Programmablauf.
      * @since 1.0
      */
     
     public static void main(String[] argv) {


       ..............

}

 

[Guest]

Sehr ihr hier irgendeinen Fehler? Also ich nicht...

 

[Guest]

Leute?

 

[Beni]

Musst javadoc noch sagen, welche Tags es verarbeiten soll. Dir fehlt wohl mindestens das "-author".

siehe hier