Using <param> XML Tag in C# to create Intellisense in my DLL


M

Michael.Suarez

The code in my DLL:

/// <summary>
/// db_task..file_master_list
/// </summary>
/// <param name="panConnection">
/// Pass the PanApp.Connection object by reference
/// </param>
/// <param name="source_id">
/// Default Value = 0
/// </param>
/// <param name="frequency_cd">
/// Default Value = ""
/// </param>
public static int file_master_list(ref SqlConnection
panConnection, int source_id, string frequency_cd, string
search_string)
{
//code
return 0;
}

Yet no Intellisense.

I also added the pre-build event:
/doc:db_taskLib.dll.xml

And on the build, I got the error:
The command "/doc:db_taskLib.dll.xml" exited with code 123.

The xml file that gets created has none of the xml I typed in my source
code.

What else do i need to do to get this to work?
I am using VS 2005.

Thanks,
-Mike
 
Ad

Advertisements

D

Daniel O'Connell [C# MVP]

The code in my DLL:

/// <summary>
/// db_task..file_master_list
/// </summary>
/// <param name="panConnection">
/// Pass the PanApp.Connection object by reference
/// </param>
/// <param name="source_id">
/// Default Value = 0
/// </param>
/// <param name="frequency_cd">
/// Default Value = ""
/// </param>
public static int file_master_list(ref SqlConnection
panConnection, int source_id, string frequency_cd, string
search_string)
{
//code
return 0;
}

Yet no Intellisense.

I also added the pre-build event:
/doc:db_taskLib.dll.xml

And on the build, I got the error:
The command "/doc:db_taskLib.dll.xml" exited with code 123.

The xml file that gets created has none of the xml I typed in my source
code.

What else do i need to do to get this to work?
I am using VS 2005.

Try enabling xml document file generation by going to the project
properties->Build and checking XMLdocumentation file.
 
Ad

Advertisements

J

Jay R. Wren

I highly recommend Ghostdoc. It is a Visual Studio Add-In which writes
xml doc comments for you, or at least the skeleton.

http://www.roland-weigelt.de/ghostdoc/

I bind its "Document This" command to Ctrl-Alt-d and the XML
documentation comments practically write themselves.
 

Ask a Question

Want to reply to this thread or ask your own question?

You'll need to choose a username for the site, which only take a couple of moments. After that, you can post your question and our members will help you out.

Ask a Question

Top