Version imprimable
Bonjour,
Je vais changer de société et on me demande une bonne documentation. Je me suis dit que la Javadoc ferait l'affaire mais c'est très peu comme résultat.
Que me conseilleriez-vous pour améliorer cela ou encore, y a-t-il d’autres possibilités pour générer de la documentation d'un code source existant ?
Merci d'avance pour votre aide.
La javadoc ne fait que "formater" la documentation que tu as indiqué dans le code source.
Ce ne sera pas magique, si tu ne documentes pas bien tes classes, méthodes, ... ça ne sera pas correctement.
De manière générale, les outils de génération de documentation ne font une bonne documentation, uniquement si la documentation se trouvant dans le code est correcte. Des plus Javadoc à une approche très "API". Ca va documenter très bien des méthodes et tes classes de manières "unitaires" mais ne va pas documenter de manière plus globale, comme par exemple la conception de l'application si c'est l'objet de tes developpements, où la manière dont fonctionnement les différents classes, interfaces entre elle.
Pour rédiger une bonne documentation, le mot d'ordre doit êtr "qu'est ce que je dois avoir comme information pour pouvoir utiliser le code réalisé ?" Donc forcement un moment données des pages qui explique un peut comment fonctionnnent ton API
Vas voir les docs des produits, comment Spring par exemple => une doc + une javadoc