Usando Monodoc

Por razones de compatibilidad de algunas herramientas de desarrollo, dejé de usar windows en mi máquina, y por lo tanto, para desarrollar aplicaciones .NET me veo obligado a usar Mono como compilador y MonoDevelop como IDE.

Enseguida veremos como generar la documentación de proyecto de una librería desarrollada con MonoDevelop.

1.- Lo primero que hay que hacer es compilar el proyecto desde MonoDevelop, y copiamos el comando de compilación ya que usaremos éste para generar la documentación en formato XML agregando la opcion /doc de la siguiente manera:

/usr/lib/mono/4.5/mcs.exe /noconfig /debug:full /debug+ /optimize- /out:obj/Debug/netDb.dll absLayer.cs absMySql.cs absOdbc.cs absSqlServer.cs netDb.cs Properties/AssemblyInfo.cs netDbTest.cs Logger.cs obj/Debug/.NETFramework,Version=v4.5.AssemblyAttribute.cs /target:library /define:"DEBUG;TRACE" /nostdlib /reference:/usr/lib/mono/4.5/System.dll /reference:/usr/lib/mono/4.5/System.Xml.Linq.dll /reference:/usr/lib/mono/4.5/System.Data.DataSetExtensions.dll /reference:/usr/lib/mono/4.5/Microsoft.CSharp.dll /reference:/usr/lib/mono/4.5/System.Data.dll /reference:/usr/lib/mono/4.5/System.Xml.dll /reference:packages/NUnit.2.6.4/lib/nunit.framework.dll /reference:packages/MySql.Data.6.9.6/lib/net45/MySql.Data.dll /reference:packages/log4net.2.0.3/lib/net40-full/log4net.dll /reference:/usr/lib/mono/4.5/System.Core.dll /reference:/usr/lib/mono/4.5/mscorlib.dll /warn:4 /doc:netdb.xml

Se creará el archivo de documentación netdb.xml.

2.- Con  mdoc generamos la documentación completa del proyecto, con el siguiente comando:

mdoc update -o docs -i netdb.xml bin/Debug/netDb.dll

3.- Exportamos la documentación a formato HTML ejecutando el siguiente comando:

mdoc export-html -o html docs/

Ahora tenemos la documentación del proyecto en el directorio html.