Blog Home  Home Feed your aggregator (RSS 2.0)  
DocProject - Manuel Abadia's ASP.NET stuff
 
# Thursday, November 15, 2007

One of the coolest tools I have been using for the lasts months is DocProject:

http://www.codeplex.com/DocProject/

DocProject generates documentation from an xml comment file using sandcastle. The generated documentation can be a precompiled help file (help 1.x or help 2.x) or a web site.

There are other tools that serve as a friendly GUI for sandcastle but DocProject integrates great with Visual Studio 2005 (and 2008) and lets you create and maintain the documentation without effort.

When DocProject is installed, two new project types will show in the “New Project Dialog”:

• Project Documentation: that lets you generate a precompiled help file.
• DocSite Web Application: that creates a web site with the documentation.

When you select one of those project types, it will ask you for which projects you want to generate the documentation, and basically that is all that you need to get DocProject working (of course you need to generate the xml comment file for the projects you want to document, so be sure to have the checkbox at “Build -> Output -> XML documentation file” enabled in the project properties.

You can configure a lot of options when generating the documentation. To do that you have to click in Tool->Options->DocProject. I won’t detail the options, but it is really straightforward to use. The only thing I miss is that this can’t be done in the project properties for the projects created by DocProject.

There are several styles available for the generated documentation. Here is a pic of a precompiled help file of the one I’m using:

You can take a look at a website that uses DocProject here:

http://docs.mbunit.com/

If you compile often (as I do) you will see that generating the documentation takes a long time so probably you’ll want to exclude the generation of the documentation when you compile (Build->Configuration Manager->uncheck the build from the documentation project) and build it when you really need it or if you have use a continuous integration server, let it do the work for you.

So the only excuse now to not have good documentation for your projects is being lazy.

Thursday, November 15, 2007 11:58:43 PM (Romance Standard Time, UTC+01:00)  #    Comments [3]   Microsoft .NET Framework | Visual Studio  | 
Friday, November 16, 2007 2:15:05 AM (Romance Standard Time, UTC+01:00)
Hi Manuel,

Thanks for the post. (I get notified by Google when there are new blog posts about DocProject ;)

1. The regular DocProject template is now called "DocProject" instead of "Project Documentation".

2. In VS Standard+ you can use the DocProject Properties window instead of the Tools Options page as of the 1.8.0 RC. (And BTW, it's up to 1.9.0 RC now :)

Thanks again!
- Dave
Friday, November 16, 2007 7:02:48 AM (Romance Standard Time, UTC+01:00)
Dave,

I should have posted about the version I was using (I think it's 1.7.0) but it's nice that the only thing I was missing from DocProject has been added. I think I'll wait until 1.9.0 is out for an upgrade (I'm lazy upgrading things that work good ;-)

Thank you for the clarifications and for your awesome project!
Thursday, May 15, 2008 7:07:57 PM (Romance Daylight Time, UTC+02:00)
I'm currently working on API-documentation as well, and already did some tests with DocProject, but I do miss a nice topic designer. I see you created seperate HTML-files as well for your custom topics (getting started for example), but you refer to your own CSS-class!?

<link rel="stylesheet" href="../Styles/MbUnitDocs.css" />

A second thing I noticed was the nice code-formatting. Is this done manual ? If not .. which tool did you use for this nice style ? (<div class="csharpcode">.. etc).

And to end .. how did you make the thumbnails ?

I know you can do all the steps manual, but it will take a lot of time to create some nice documentation :(

Thanks in advance for any help !
All comments require the approval of the site owner before being displayed.
Name
E-mail
Home page

Comment (Some html is allowed: a@href@title, strike) where the @ means "attribute." For example, you can use <a href="" title=""> or <blockquote cite="Scott">.  

[Captcha]Enter the code shown (prevents robots):

Live Comment Preview
Copyright © 2019 Manuel Abadia. All rights reserved.
DasBlog 'Portal' theme by Johnny Hughes.