Gonzalo ha fornito una buona panoramica dei diversi moduli.
Dato che hai anche menzionato il desiderio di contribuire alla documentazione, ti serviranno altre informazioni.
Innanzitutto, la documentazione è memorizzata in file XML entro mc/classe/[assemblaggio]/documentazione/, ad es. mcs/class/corlib/Documentation. L'intento è quello di supportare più lingue umane (anche se attualmente è in lavorazione solo l'inglese), quindi all'interno della documentazione la documentazione è una directory di lingua, solitamente en
. All'interno di en
ci sono i file ns-*.xml
, ad es. mcs/class/corlib/Documentation/en/ns-System.xml contiene la documentazione per lo spazio dei nomi System
. Anche all'interno di en
ci sono le directory "namespace punteggiato" e all'interno di questi ci sono file XML, uno per tipo, ad esempio mcs/class/corlib/Documentation/en/System.Collections.Generic/IEnumerable`1.xml.
Questo è anche descritto nella documentazione mdoc(5), nella sezione FILE/DIRECTORY STRUCTURE
.
Una volta trovata la documentazione, è necessario conoscere il formato XML, che è anche descritto nella documentazione mdoc(5), nella sezione NamespaceName/TypeName.xml File Format
. Il dialetto XML utilizzato è una variante di ECMA 335XML documentation, modificata per avere un file per tipo (anziché tutti i tipi all'interno di un singolo file monolitico). Questo è anche un superset di C# XML documentation (vedere Annex E. Documentation Comments
, pagina 487).
Infine, c'è la domanda di aggiungere nuovi tipi/membri alla directory mcs/class/[assembly]/Documentation. Se hai creato Mono, puoi utilizzare il target Makefile doc-update
.Ciò eseguirà l'assembly appropriato tramite mdoc(1) e aggiornerà i file appropriati all'interno della directory Documentazione.
Se avete altre domande sulla documentazione, non esitate a chiedere sulla mailing list mono-docs-list.
Grazie mille per aver descritto la struttura delle directory, sapete anche se esiste un sito web che lo descrive? – markmnl
C'è https://github.com/mono/mono/blob/master/README.md – Gonzalo