Gonzalo proporcionó una buena visión general de los diferentes módulos.
Como también mencionó que desea contribuir a la documentación, querrá algunos datos más.
Primero, la documentación se almacena en archivos XML dentro de mcs/class/[assembly]/Documentation/, p. Ej. mcs/class/corlib/Documentation. La intención es admitir varios idiomas humanos (aunque actualmente solo se está trabajando en inglés), por lo que dentro de Documentación es un directorio de idiomas, generalmente en
. Dentro de en
hay ns-*.xml
archivos, p. mcs/class/corlib/Documentation/en/ns-System.xml contiene documentación para el espacio de nombre System
. También dentro de en
se encuentran los directorios de "espacio de puntos punteados", y dentro de ellos hay archivos XML, uno por tipo, por ejemplo mcs/class/corlib/Documentation/en/System.Collections.Generic/IEnumerable`1.xml.
Esto también se describe en la documentación mdoc(5), en la sección FILE/DIRECTORY STRUCTURE
.
Una vez que haya encontrado la documentación, necesita conocer el formato XML, que también se describe en la documentación mdoc(5), en la sección NamespaceName/TypeName.xml File Format
. El dialecto XML utilizado es una variante del ECMA 335XML documentation, modificado para tener un archivo por tipo (en lugar de todos los tipos dentro de un único archivo monolítico). Este también es un superconjunto de C# XML documentation (ver Annex E. Documentation Comments
, página 487).
Finalmente, está la cuestión de agregar nuevos tipos/miembros al directorio mcs/class/[assembly]/Documentation. Si tiene Mono incorporado, puede usar el objetivo de Makefile doc-update
.Esto ejecutará el ensamblado apropiado a través del mdoc(1) y actualizará los archivos apropiados dentro del directorio Documentation.
Si tiene alguna otra pregunta sobre la documentación, no dude en preguntar en la lista de correo mono-docs-list.
Muchas gracias por describir la estructura del directorio, ¿sabe también si hay un sitio web que describa esto? – markmnl
Hay https://github.com/mono/mono/blob/master/README.md – Gonzalo