Traductions de cette page:
  • fr

Documentation API — µcBlockly

Ce site est généré avec TypeDoc à partir des sources TypeScript dans src/.

Générer la documentation

npm run docs

La sortie HTML est écrite dans docs/api/. Ouvrez docs/api/index.html dans un navigateur (ou servez le dossier avec un serveur HTTP statique).

Conventions de commentaires (TSDoc)

Les commentaires suivent la spécification TSDoc, compatible avec TypeDoc et validée par ESLint (eslint-plugin-tsdoc).

  • @packageDocumentation — en tête de fichier : rôle du module (affiché par TypeDoc).
  • @module — identifiant hiérarchique du module (ex. Arduino.Generators.Math).
  • @description, @remarks — description courte / détails.
  • @param, @returnsAPI publiques (fonctions, méthodes).
  • @license, @author — métadonnées si besoin.

Évitez les balises @fileoverview (héritage JSDoc) : intégrez le texte dans @remarks ou @description du bloc @packageDocumentation.

Pour plus de détails, voir Architecture et Contribution.