• [^] # Re: Documentation

    Posté par . En réponse au journal De tout, de rien, des liens, bla bla bla. Évalué à 2.

    1. S'il y a bien un endroit (en fait, le seul!) où le copier-coller est tolérable, c'est la documentation des interfaces. C'est parfois automatisable avec des macros (comme dans les macros MDOC ou MAN pour les pages de man) mais parfois le plus court chemin est le copier-coller.

    En javadoc, {@inheritDoc} copie automatiquement la javadoc d'une méthode depuis l'interface/la super classe vers la méthode dans le sous type.

    1. Dans ce cas la clause return … ne sert à rien car elle n'apporte pas de nouvelle information!

    C'est pour ça que je ne documente que le clause @return.