Har nu skrivit min kod och ska se till att allt är uppställt som i Javadoc's konventioner.

Förstår bara inte riktigt VAD Javadoc ÄR.

ÄR det ett litet program som sätter in /** och @ tecken på rätt ställen?


Har läst på Sun's hemsida om det men förstår inte riktigt om det är regler som jag personligen ska följa och SJÄLV skriva dit allt på rätt sätt - eller om Javadoc är ett program som gör detta åt mig.

Jag trodde att det var ungefär som följande:

1. Jag skriver programkoden i en Notepad och sparar som .java
2. Jag kompilerar och då uppstår en .class fil
3. Samtidigt uppstår också ett "javadoc-dokument".

...men så kanske det inte är?????

Det verkar vara något dokument som ska kunna ses i en Browser.

HOPPAS NÅGON KAN FÖRKLARA DETTA FÖR MIG.

Javadoc är ett program som skapar HTML-sidor med dina kommentarer och metodnamn osv. Jag tror att Java-API är skapad med Javadoc. För att bättre förstå vad det gör prova detta. Skriv ett litet program (du behöver inte skriva några kommentarer) och skriv sedan javadoc dittprogram.java i prompten. Kolla här också: http://java.sun.com/j2se/javadoc/writingdoccomments/

Det finns speciella tags som man kan använda för att dokumetera sin klasser. Exempel på dessa är:

Upphovsman:
<code>
/**
*@ author Vem som skapat klassen, Företag AB
*/
</code>

Beskrivning av en funktion
<code>
/**
* Allmän beskrivning av funktionen
* @param int IDRäknare
* @return String
*/
</code>

Koden som beskriven funktionen sätter man ovan den funktion man vill beskriva.

Vill du sedan producera din java-dokumentation är det bara att köra kommando:

<code>
javadoc programfil.java
</code>

Efter detta finns det en hel massa html dokument var du kompilerade programmet. Öppna upp index.html så kan du läsa din dokumentation.

mvh,

Philip