97 messaggi dal 26 febbraio 2007
Ciao,

Nel mio codice ho inserito dei commenti XML (su tutte le WEBAPI) del mio progetto.
Per esporre la documentazione delle webapi ho utilizzato Swagger e mi trovo molto bene.

Però oltre a questo, la mia solution ha delle referenze su altri progetti (Class Library) e vorrei fare in modo di generare anche una documentazione per tutte le Classi (o la massimo le Interface) che hanno dei commenti XML.

Che cosa potrei fare per scrivere una documentazione automatica per loro? (non ho la necessità di esporre sul web queste, mi basterebbe generare anche un file di testo per poterlo leggere offline).


Grazie
316 messaggi dal 05 novembre 2012
Ciao,

prova a dare una lettura qui

Personalmente non ho esperienza sulle alternative segnalate, di conseguenza non posso consigliartene una in particolare

UPDATE: ho dato per scontato che già conosci l'abilitazione della documentazione xml nelle proprietà del progetto (tab Build sezione Output)...con uno sforzo minimo è già questa la documentazione che ti serve, naturalmente essendo in formato xml non è il massimo per la consultazione...principalmente i tool che trovi nel link segnalato partono da questo file per creare versioni più fruibili

Eventualmente, sei hai voglia, riporta le tue impressioni se provi qualche tool

/Ciao
Modificato da scioCoder il 14 marzo 2019 15:00 -

Alessio
97 messaggi dal 26 febbraio 2007
Per adesso sto andando avanti con le sole WebAPI utilizzando Swagger e mi sto torvando benissimo.


Se dovessi passare anche alla documentazione delle classi ed interfacce ti farò sapere, in giro anche io ho trovato sempre DocFX, quindi nel caso sarei orientato per quello.
316 messaggi dal 05 novembre 2012


Buon lavoro
/Ciao

Alessio

Torna al forum | Feed RSS

ASPItalia.com non è responsabile per il contenuto dei messaggi presenti su questo servizio, non avendo nessun controllo sui messaggi postati nei propri forum, che rappresentano l'espressione del pensiero degli autori.