====== Documentation technique ======

===== Principes =====

Notion d'API

Exemple : [[https://docs.oracle.com/javase/8/docs/api/overview-summary.html | La documentation technique Java]]
===== Formats et tags courants =====

Voir [[https://idratherbewriting.com/learnapidoc/nativelibraryapis_javadoc_tags.html|javadoc tags]]
===== Aide à la saisie =====

Sur la ligne qui précède la signature d'une classe ou la signature d'une méthode, saisir : <code java>/** </code>et faire **<Entrée>**. L'IDE alimente une zone d'auto-documentation type qu'il reste à compléter : 
<code java>
/**
 *
 * @author aserres
 */</code> 
===== Java/NetBeans =====
Un clic droit sur le projet et choisir "**Generate Javadoc**"

La Javadoc est alors disponible dans le sous-dossier **dist/javadoc** du projet.
===== PHP/NetBeans =====
Voir [[bloc2:prog:gen:netbeans-config#php_doc | NetBeans - Configuration]]