Automated doc for dotnet app

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

What needs to installed:

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:

Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s