26-4 Documenter les interfaces (modèles)

La documentation des modèles est relativement simple. Vous pouvez préciser via @example un exemple de valeur pour les propriétés moins évidentes.

src/app/core/models/projet.ts

export interface Projet {
  /**
   * L'identifiant unique du projet
   */
  id: number;

  /**
   * le nom du projet
   */
  nom: string;

  /**
   * La description du projet.
   */
  description?: string;

  /**
   * L'URL de l'image associée au projet
   * @example 'https://placehold.co/600x400'
   */
  image_url?: string;

  /**
   * La date de création du projet
   */
  created_at: string;

  /**
   * La date de dernière modification
   */
  updated_at: string;
}