Documentazione del codice in DART

Question

Abbiamo qualsiasi sintassi della documentazione del codice e supporto utensile per la generazione di documentazione del codice fuori dal codice dell'applicazione DART, qualcosa di simile a DOXYGEN per C / C ++.Preferisco utilizzare la sintassi del markdown disegnata rispetto alla sintassi doxygen.

Answer 1

Lo strumento DARTDOC (che utilizza Markdown) crea documentazione API (come trovato a API.DARTLANG.org ) .

Questo descrive il riferimento API per l'utilizzo di DartDoc nel proprio codice

.

the readme.txtQui , mostra come è possibile formattare i commenti del tuo codice per generare API DOC

Answer 2

///I am the beerclass
class BeerClass{
  ///this is a beer variable
  String beername;

  ///this is a beer method
  String get getBeer => "beer for the people";
}

.

Basta andare nel Dardeditor: Strumenti-> Genera DartDoc .Ottieni una nuova directory docs e si avvia Index.html nel tuo browser.La tua classe, variabile e metodo ha ora documentazione.