Javadoc Tagleri

Giriş

Javadoc tag'leri @ karakteri ile başar. Açıklaması şöyle

@author: You can define who created this class, package, or method

@since: specify when a feature or method was added

@version: the current version

@param: given a method or a constructor, the argument information

@return: given a method a description about what is returning

@throws: what can go wrong on this call? It is a tag to explain it so the user can avoid it. 

@see: to get more information on another method.

{@code ...}

Şöyle yaparız. Javadoc içinde java kodu yazabilmeyi sağlar

/**
 * ...
 * <pre>{@code
 *   ...
 * }</pre>
 */

{@link ...}
Hyperlink şeklinde diğer sınıfa bağlantı verir. @link'ten sonra gelen ilk kelime sınıf ismini, ikinci kelime ise Javadoc'ta görünecek kelimeyi belirtir. Sınıfın içindeki bir alana atıfta bulunmak için # karakter kullanılır. Mesela com.foo.Bar#field1

Atıfta bulunmak istediğimiz sınıf veya metod public olmalıdır.  Eğer public değilse @see kullanılabilir.

Örnek - Metoda Atıf

Şöyle yaparız

@deprecated please use {@link Team#of(String)} instead
veya
@return a {@link Team} instance

Örnek - Sınıfa Atıf

Şöyle yaparız. 

/**
 * Returns an {@link Identity Identity(s)} ...
 */

{@see ...}

Örnek

Şöyle yaparız. Burada atıfta bulunulan metod private olsa bile hatalı değil.

/**
 * This class represents a dog.
 *
 * @see Dog#bark()
 */
public class Dog {

  private void bark() {
    System.out.println("Woof!");
  }
}