Lab 10 : Compodoc

📖 Ressources

• Documentation officielle de Compodoc
• Commentaires JSDoc

🚀 Code de départ

step-5-album-wholesale-v16-post-add-custom-async-validator

Continuez depuis le résultat du Lab 09. Si vous avez besoin d’une copie fraîche, utilisez step-5-album-wholesale-v16-post-add-custom-async-validator comme base et complétez d’abord les Labs 05–09.

Dans ce lab, vous allez générer une documentation complète du projet en utilisant Compodoc. Vous allez installer l’outil, ajouter des commentaires JSDoc à votre code, configurer des scripts npm, et servir une documentation interactive pour votre application Angular.

📝 Instructions

Étape 1 : Installer Compodoc

npm install --save-dev @compodoc/compodoc

Étape 2 : Ajouter des commentaires JSDoc

Ajoutez de la documentation à votre code :

/**
 * Service pour gérer les données des albums
 */
@Injectable({ providedIn: 'root' })
export class AlbumService {
  /**
   * Récupère tous les albums
   * @returns Observable d'albums
   */
  getAlbums(): Observable<Album[]> {
    return this.http.get<Album[]>(this.apiUrl);
  }
}

Étape 3 : Ajouter un script npm

Dans package.json :

{
  "scripts": {
    "compodoc:serve": "compodoc -p tsconfig.json -s"
  }
}

Étape 4 : Générer la documentation

npm run compodoc:serve

Ceci ouvre la documentation sur http://localhost:8080