web-dev-qa-db-fra.com

Comment insérer la date de création dans JavaDoc

Quelle est la meilleure façon d'insérer la date de création d'une classe dans JavaDoc? Quelques exemples:

Sous la balise d'auteur avec la chaîne "créé le"

/**
 * Class description
 *
 * @author Author Name
 * created on 2015/04/01
 */
public class ClassName() {
...
}

Sous la balise d'auteur avec la chaîne "Date:"

/**
 * Class description
 *
 * @author Author Name
 * Date:   2015/04/01
 */
public class ClassName() {
...
}

Avec une balise @date inexistante

/**
 * Class description
 *
 * @author Author Name
 * @date   2015/04/01
 */
public class ClassName() {
...
}

Autre...

Et finalement, quel est le meilleur format de date?

April 1, 2015
2015/04/01
...
19
ᴜsᴇʀ

La plupart des IDE ont un mécanisme pour définir des modèles à utiliser lors de la création de nouvelles classes. La date actuelle peut généralement être insérée dans le cadre du modèle.

Par exemple, ici est la documentation pour Eclipse et cette page affiche les variables qui peuvent être utilisées dans les modèles.

4
Brett Okken