Javadoc dokumentation?!?

når men det kunne være at jeg også skulle få classen med:-)

import javax.media.jai.*;
import java.util.*;
import java.io.*;
import java.awt.image.renderable.*;


class BilledeBeregner
{
    public static void main(String args[])
    {

                BilledeBeregner bb = new BilledeBeregner();

                //henter datering til billeder
                Calendar nu = Calendar.getInstance();
                int time = nu.get(Calendar.HOUR_OF_DAY);
                int minut = nu.get(Calendar.MINUTE);
                int sek = nu.get(Calendar.SECOND);
        int maaned = nu.get(Calendar.MONTH);
                int dag = nu.get(Calendar.DAY_OF_MONTH);
                int aar = nu.get(Calendar.YEAR);

        //henter første billede
        ParameterBlockJAI loadPB1 = new ParameterBlockJAI("fileload");
        loadPB1.setParameter("filename", "C:\\mappe2\\4.jpg");
        PlanarImage image1 = JAI.create("fileload", loadPB1);

        //henter andet billede
        ParameterBlockJAI loadPB2 = new ParameterBlockJAI("fileload");
        loadPB2.setParameter("filename", "C:\\mappe2\\1.jpg");
        PlanarImage image2 = JAI.create("fileload", loadPB2);

                //sætter resultat af PlanarImage = forskellen af image1 og image2
        PlanarImage resultant = bb.difference(image1,image2);
                //Opretter metode til (a)
        boolean a = bb.differenceN(image1,image2);



        //gemmer billede i mappe hvis (a) er sand

        if (a)
           
            //JAI.create("filestore", image1, "C:\\mappe1\\"+dag+" "+maaned+" "+time+" "+minut+ " "+sek+" "+aar+".jpeg ", "jpeg", null) ;

              JAI.create("filestore", image2, "C:\\mappe1\\1.jpeg ", "jpeg", null) ;
                else
            System.out.println("  "+time+ " "+minut+ " "+maaned+ " "+dag+ " "+aar+ " ");

    }

    public PlanarImage difference(PlanarImage img1, PlanarImage img2)
    {
        //beregner forskellen mellem de to billeder
        ParameterBlockJAI op = new ParameterBlockJAI("subtract");

        op.addSource(img2);
        op.addSource(img1);

        PlanarImage returnValue = JAI.create("subtract", op);

        return returnValue;
    }

    public boolean differenceN(PlanarImage img1, PlanarImage img2)
    {
        PlanarImage im = difference(img1,img2);

        // opretter parameter block for source billedet samt for konstanden
            ParameterBlock pb = new ParameterBlock();
            pb.addSource(im);  // source billedet
            pb.add(null);        // det område at billedet der analyseres(hvis null analysere hele billedet)
            pb.add(5);        // den horisontale sampling rate
            pb.add(5);        // den vertikale sampling rate

            // udfører extrema operation på source billedet
            RenderedOp op = JAI.create("extrema", pb);

            // henter både den maximale og den minimale pixelværdi
            double[][] extrema = (double[][]) op.getProperty("extrema");

            double max=0;

            for (int x=0;x<extrema.length;x++)
                for (int y=0;y<extrema[0].length;y++)
                    if (extrema[x][y]>max)
                        max = extrema[x][y];

            System.out.println(max);

            if (max>150.1)
                return true;
            else
                return false;

    }


}

Source koden kommer aldrig med i javadoc'en
det ville også være helt forkert i det
det er meningen at man kan ændre implementeringen
uden at brugen af ens klasser ændres. Iøvrigt
skriver du jo ikke nogen dokumentation til
javadoc i dit eksempel:
/**
* The method differenceN ..
**/
public boolean differenceN(PlanarImage img1, PlanarImage img2)

Ja der kan man bare se...jeg havde ikke styr på hvordan Javadoc virkede. Nå men det jeg så skal bruge er en grundig dokumentation af min kode til brug i en eksamens rapport. Du har vel ikke et forslag til hvordan det bedst kan gøres?!

Du skriver som nævnt ovenfor en javadoc
kommentar til hver metode der er public
(måske også for de andre men for nu..)
der har formen:
/**
*The method does .....
*@param img1 is an image of ....
*@param img2 is another image ....
*@author babynamnam
*@version 1.0
**/
hvor du har en @param tag for hver parameter
og en @return tag for metoder der returnerer
noget, f.eks.
@return the perfeect image of ..
Du skal også have n /** beskrivelse
**/ af klassen allerøverst.
Husk at javadoc /** **/ skal komme
umiddelbart før din metodeerklæring.
Ved du hvordan du skal køre javadoc?

du kan evt. kigge lidt på hvordan sun selv har gjort. Source koden til jdk'en ligger i roden af jdk dir'et og hedder src.jar (rename til zip og undersøg den med et zip program..)

Jeg ved godt hvordan jeg køre javadoc hvis det ellers er fra JBuilder, kan det for øvrigt ikke lade sig gøre at for det ud som et tekst dokument!?

Nej, det er det ikke, med mindre du opfatter
html som tekst:)

findes der ikke en eller anden form for java dokumentations manager som fx. VBdocman til visual basic!?

Metoderne dokumenterer man i javadoc'en

men resten af dokumentationen laver man som kommentarer i .java filen.

f.eks.

Javadoc specificerer hvad metoden gør, og hvilke parametere den har
Kommentarerne forklarer hvordan den gør det.

lukket

baby:
Øh du har fået svar der beskriver hvordan man laver javadoc