Automated doc for dotnet app

It seems Sandcastle is the only option for auto-doc dotnet app.

What needs to installed:

• Sandcastle help compiler
• Sandcastle help file builder (GUI)
• HTML Help 1 compiler ( I don’t know how to use HTML help 2 format yet, this regular chm file is good enough for us)

The Sandcastle help file builder supports command line very well, it can be very easily added to cc.net.

  <target name="build.sandcastle.doc" >

	<property name="msbuild.exe" value="c:\windows\Microsoft.NET\Framework\v3.5\msbuild.exe" />
	<property name="sandcastle.proj" value="doc.shfbproj" />
       <exec program="${msbuild.exe}" failonerror="true">
          <arg line="${sandcastle.proj}"  />
          <arg line="/p:Configuration=release"  />
       </exec>

    <copy file="${dir.base}/help/Documentation.chm" todir="${dir.release}" />
  </target>

Reference: Recommended Tags for Documentation Comments

Note:

Namespace comments can be defined in a class, or in sandcastle project config file:

Advertisement