classi di implementazione in grado di “ereditare” commenti XML da loro interfacce implementate?

Question

domanda curiosa. Sto utilizzando Sandcastle di Microsoft per generare la documentazione dai commenti XML nel mio codice C #. Molte delle mie classi stanno implementando le interfacce che hanno già commentato metodi. Preferirei non duplicare la documentazione sia nel metodo di interfaccia e il metodo pubblico implementato. C'è una sorta di tag posso utilizzare per "ereditare" questa documentazione dall'interfaccia?

Answer 1

Questa funzione non esiste attualmente in Visual Studio.

È possibile ottenere strumenti di terze parti, come ad esempio GhostDoc che vi aiuterà con la creazione di documentazione XML. GhostDoc ha anche la possibilità di generare la documentazione che è stato "ereditato", come si sta tentando di fare.

Link: GhostDoc

Answer 2

È possibile aggiungere <inheritdoc/> nell'attuazione.

Si dovrebbe avere uno sguardo su questo thread: per sincronizzare interfaccia e implementazione commenti in C #

Answer 3

Nel caso in cui qualcun altro è alla ricerca di una soluzione, ho costruito una libreria di post-processo i file di documentazione XML per aggiungere il supporto per un tag.

Maggiori informazioni su www.inheritdoc.io (versione gratuita disponibile).