Add project description for "Build Comment Web Pages.."

[randall2nd]

I am using Microsoft Visual Studio .NET 2003, and buildiing a solution with 3 projects all in C#.

I have gone through my code and added the XML comments for all the bits and pieces, and in every place I can think of.

Howver I can not seem to find the correct place to add them so that after I click "Tools|Build Comment Web Pages ..." a description for the project will be generated in the comment web pages.

Any ideas on how to get the description into the generated comment web pages?

Randall2nd

 

[obislavu]

Tools-> Build Comments web pages -> a html file will be created
Even you do not have xml comments for classes, methods and members the file will be generated.
If you have comments in the code then all these comments will be very well displayed for each class, method and members. Just put that before the declaration like here:
/// <summary>
/// Takes the content of a DataTable and insert it into a MSSQL Table (Table MUST exist)
/// </summary>
/// <param name="SourceTable">Source Table</param>
/// <param name="DestTable">Destination Table</param>
/// <param name="connString">Connection string for Database(MSSQL)</param>
/// <param name="EmptyDestTable">When set to true, delete content of destination table</param>
/// <param name="clientPath">Path to put file containing duplicate values</param>
/// <param name="DeleteDuplicateLogFile">When set to true, delete duplicate log file.</param>
/// <param name="bDuplicates">returns true if there is duplicate value(s) otherwise false</param>
/// <returns>true/false</returns>
public bool _LoadDataTable2SQLTable(DataTable SourceTable, string DestTable,string connString, bool EmptyDestTable, string clientPath, bool DeleteDuplicateLogFile, ref bool bDuplicates)
{
}

-obislavu-

 

[chiph]

You might also want to look at NDoc. It will produce HTML Help files (*.chm).

Chip H.


If you want to get the best response to a question, please check out FAQ222-2244 first

 

[randall2nd]

Thank you both for your response. I am primarily looking for a simple way to produce a maintenance manual of sorts, and the lead directed me to take this route.

I will take a look at Ndoc.

The problem I am having is that I do not know how to put Xml comments in the code so that the PROJECT will have a description.

for example
I Open a solution in Microsoft Visual Studio .Net 2003
Click on "Tools|Build Web Comment Web Pages ..."
In the Pop-up box I select "Build for entire Solution"
I then click OK and wait.
The generated Start page opens to the Solution level.
It lists all the projects I have under Project.
However the Description coulmn is BLANK!!!
Click a project and the right frame just has Project Name

I know I can open the Html files and edit them by hand. Not what I am looking to do, after all they will just be overwritten each time I regenerate the comment pages.

How do I add a project description using Xml comments in the code.

Also if anyone knows how to hide/prevent items from showing up please let me know. (such as buttons, labels, testboxes, etc...)

Randall2nd