2008年7月2日星期三

DocProject, a document generate tool

To setup the environment, you need install these software
  1. VisualStudio 2005 or 2008;
  2. Sandcastle
  3. Help 1.x
  4. Help 2.x (optional)
  5. DocProject

Make your "Hello World" DocProject

  1. Create a C# project, do some comments in the codes, check the "XML Documentation File" in project properties "Build" tab.
  2. Create a DocProject project, just follow the wizard, you can easily to setup it;
  3. Compile the projects, this may take some time, just be patient.
  4. After compile finished, you get your document. Yeah~~

Others

After do these, you may get a compile warning 1591, because you are not comment all the classes, functions, etc. Your can suppress this warning in project properties "Build" tab.

没有评论: