documentazione del codice dattiloscritto [chiuso]

6

la mia domanda è piuttosto breve:

Come posso documentare correttamente il codice dattiloscritto? Ho scoperto che per i progetti sempre più grandi, è importante guardare a una funzione e conoscere immediatamente i parametri, cosa restituisce e gli effetti collaterali ecc. È stancante avere solo un mucchio di commenti prima di una funzione, la maggior parte dei il tempo in cui questi "blocchi" hanno anche uno stile diverso. Quello che sto cercando è uno strumento di documentazione come javadoc o doxygen per dattiloscritto. C'è qualcosa là fuori? Oppure è possibile "abusare" di uno strumento di documentazione e farlo funzionare con dattiloscritto?

    
posta Max Beikirch 19.01.2013 - 14:32
fonte

1 risposta

1

Se stai cercando qualcosa come JavaDoc, potresti trovare utile JsDoc.

Ho scritto un piccolo strumento per convertire i commenti JsDoc nei file di definizione TypeScript in pagine HTML in stile JavaDoc con collegamenti tra i tipi.

Puoi trovarlo qui, ma in questo momento deve essere creato dalla fonte:

typescript-docs

    
risposta data 25.10.2013 - 02:06
fonte

Leggi altre domande sui tag