Table des matières

Documentation technique

Principes

Notion d'API

Exemple : La documentation technique Java

Formats et tags courants

Voir 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 :

/** 

et faire <Entrée>. L'IDE alimente une zone d'auto-documentation type qu'il reste à compléter :

/**
 *
 * @author aserres
 */

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 NetBeans - Configuration