Sandcastle project templates for Visual Studio 2005
You should by now be aware that Microsoft is developing a documentation compiler called Sandcastle. Although the project is still very much in CTP mode, I do believe that it gives you all the options you need to generate documentation for your managed code assemblies. To help you achieve that, I have previously suggested the use of Sandcastle Help File Builder. And it's still a great option it you're looking for something to replace NDoc.
But a new star is on the horizon called DocProject. I've started using it about a week ago and it has a number of very powerful features which I really like:
-
The tool integrates seamlessly with Visual Studio 2005 and adds two project templates which will help you create documentation for your solution. When you add the documentation project to your solution, a wizard will help you setup the project and add the managed assemblies in your solution to the documentation project. Once that is done, recompiling the solution is enough to generate the documentation.
-
There's also an external GUI which resembles the NDoc interface. Using this tool, Visual Studio Express users can also use the tool to create documentation.
-
The API Topic Management Dialog provides a GUI for choosing the API topics that will be built by Sandcastle. It allows a user to include or exclude namespaces, types and almost any member topic using regular expressions or categorical filters. It also provides the ability to create external XML documentation for the project, namespaces and API elements in soure mode and design mode.
-
The tool makes creating and deploying a Documentation Web site really simple.
-
The tool uses MS-Build to actually build the documentation and the integration in VS 2005 allows you to integrate Sandcastle in your daily builds using TeamServer.
-
The project site on CodePlex offers plenty of documentation and tutorials to get you started.
If you're interested in generating documentation for your managed assemblies without too much hassle, then you really need to check out DocProject. Here are some links to get you started:
Installation, Configuration and Uninstallation
Using DocProject
Tutorials