Tartalomjegyzék

< Java

Java doc

A javadoc

A Java lehetővé teszi osztályok, adattagjaik, konstruktoraik és metódusaik dokumentálást automatikusan. Ehhez egy speciális megjegyzést kell készíteni, majd a javadoc paranccsal elkészíthető a dokumentáció.

A javadoc számára a megjegyzésnek két csillaggal kell kezdődnie: 

/**
  * megyjegyzések...
  */

A javadoc parancs ezeket a megjegyzéseket veszi figyelembe.

Ha vannak külső függőségek, akkor azok útvonalát meg kell adni a -classpath vagy a -cp kapcsolóval.

Ellenőrizzük a parancs meglétét: 

javadoc --version

További kapcsolókért kérjünk segítséget: 

javadoc --help

A -d kapcsolóval adhatjuk meg, milyen könyvtárban készüljön el a dokumentáció, aminek a végeredménye egy weblap sok állománnyal.

Kód

src/Employee.java
/**
 * Dolgozókat tároló osztály
 */
public class Employee {
    String name;
    String city;
    double salary;
}
src/EmployeeFactory.java
import java.util.ArrayList;
 
/**
 * Dolgozó gyártó osztály
 */
public class EmployeeFactory {
 
    /**
     * A függvény visszatér egy dolgozó adataival, a
     * megadott név alapján. Ha több ilyen dolgozó is van
     * a függvény elsőként előforduló dolgozót adja vissza.
     * 
     * @param   name            A név amire keresünk.
     * @param   employeeList    A lista amiben keresünk.
     * @return  foundEmployee   A megtalált dolgozó.
     * @see                     Employee
     */
 
    public Employee findEmployee(String name, 
            ArrayList<Employee> employeeList) {
        Employee foundEmployee = new Employee();
        for (Employee employee: employeeList) {
            if ( employee.name.equals(name)) {
                foundEmployee = employee;
            }
        }
        return foundEmployee;
    }
}

Doc generálása

javadoc -d docs src/*

További lehetőségek

javadoc -d docs src/lan/zold/Valami.java
javadoc -d docs src/lan/zold/*.java
javadoc -d docs -cp /valahol/valami.jar src/lan/zold/*.java

Eredmény

Lásd még