Javadoc'ta sabitlerin değerlerini kullanmak

JAVADOC nedir ?

Kodunuzu başkası okuyacakmış gibi yazın çünkü siz de başkasının yazdığı kodu okumak zorunda kalacaksınız karma özdeyişiyle paralel olarak Java'yı geliştirenler en başından beri Java kodlarının kolay okunması ve anlaşılması için çok çaba sarfettiler. Java metot ve sınıflarıın dışarıdan bakıldığında ne iş yaptığını anlamanız için en basit araç Java belge üretici yani Javadoc'tur.

Metot ya da sınıfınızın üstüne yazacağınız /** */ yorum benzeri bir alana yazacağınız açıklamalar kodunuzla beraber taşınacak ve eclipse gibi bir ide'de kodun derlenmiş hali bile olsa size şu şekilde açıklamalar sunacaktır:


Ayrıca javadoc komutu ile bir API belgesi oluşturabilirsiniz http://docs.oracle.com/javase/7/docs/api/java/io/File.html#method_summary de görüldüğü üzere.


Javadoc'ta Value kullanımı

Diyelim sınıfınızda şöyle sabitler tanımaldınız:

public static final String PREFIX_REPLACEMENT_IN_COMMAND = "--prefixHere--";
public static final String PID_REPLACEMENT_IN_COMMAND = "--pidHere--";
public static final String JAR_REPLACEMENT_IN_COMMAND = "--jarHere--";

ve javadoc içinde bunların değerlerini kullanmak isterseniz yapmanız gereken şu:

/**
     *
     * @param appRootDirectoryPath
     * @param erpDao
     * @param commandToRunApp
     *            ilgili uygulamayı başlatmak için komut. {@value #JAR_REPLACEMENT_IN_COMMAND} içermeli
     * @param commandToLearnPidOfApp
     *            ilgili uygulamanın pidini almak için komut. {@value #PID_REPLACEMENT_IN_COMMAND} içermeli
     * @param commandToKillApp
     *            ilgili uygulamayı kapatmak için komut. {@value #PREFIX_REPLACEMENT_IN_COMMAND} içermeli
     */