Bonjour,
Je ne comprends pas bien ce que vous attendez de nous pour la documentation. Quelle est la différence entre documentation utilisateur et documentation de l'API ? Devons-nous faire la documentation directement sur le projet Netbeans, ou sur un fichier à part où pour chaque classe nous commentons nos méthodes?
Pouvez-vous nous éclairer sur ce point ?
Cordialement,
Pauline Gemmrich
Bonjour,
Pour répondre à votre question, la documentation utilisateur c'est le mode d'emploi pour ceux qui manipulent le logiciel et qui souhaiteraient, par exemple, afficher les fiches de soins ou autre chose.
L'API DOC c'est la documentation générée à partir de la documentation du code ; voici un exemple d'API DOC : http://camitk.imag.fr/apidocumentation/4.0/ . Des outils existent pour générer automatiquement la documentation API ou vous pouvez la fournir en la rédigeant vous-même.
Cordialement,
Jean-Loup HABERBUSCH