Ndoc Part - I
NDoc is meant for .Net Code documentation, code documentation is one of the important tasks for developers and a crucial aspect in Build engineering too. We can make the code documentation available for latest source code through our build script, for that we have to install the NDoc and then incorporate the same on build script.
Install Ndoc
There are a few different installation scenarios for NDoc, depending upon whether you use Microsoft Visual
SStudio.NET. Most of the existing documentation assumes you use Visual Studio, however, as many people don't, I'll provide the installation instructions for both Visual Studio and non-Visual Studio users here.
If you use Visual Studio.NET:
1) Verify you have the following directory: C:\Program Files\HTML Help Workshop
2) If you do not, you will have to download and install the HTML Help Workshop. Make sure you install it at C:\Program Files\HTML Help Workshop. You will find the code download at the HTML Help Workshop.
3) After ensuring the HTML Help Workshop is installed, download and install NDoc from NDoc Download. I
recommend using the Web installer version, as it contains the latest stable release. If you decide not to use
the Web installer, you will have to build the project in Visual Studio.NET. Once it's installed, you're ready to
go.
If you don't use Visual Studio.NET:
1 Ensure you have the .NET Framework installed.
2. You must install the HTML Help Workshop at C:\Program Files\HTML Help Workshop. You will find the code download here: HTML Help Workshop
3 After correctly installing the HTML Help Workshop, download and install Ndoc from NDoc Download. I
Reference: http://www.sitepoint.com/article/dot-net-xml-documentation-ndoc
This is the end of Part-I, I’ll post how to configure NDOC in MSBuild script in my subsequent posts.