/// <summary>, not working...

[SharkTooth]

I added these comments "///" (below is an example) to help the developers use the classes and methods I am adding the library. When I instantiate an object in the same project I get help, from the comments in the IDE. However if I add the library to another project I don't get the help. How can I make sure I pass the help around?


/// <summary>
/// Method accepts an SP name and Parameters and returns a DataSet that includes a table with the provided name.
/// </summary>
/// <param name="sql"></param>
/// <param name="param"></param>
/// <param name="tbName"></param>
/// <returns>A DataSet that includes a table with the provided name.</returns>
public DataSet GetOracleProcDataSet(string sql, object[,] param, string tbName)

Thanks

 

[JohnYingling]

Make sure to distribute the XML file along with the DLL file. The Doc is in the XML, not the DLL.

http://www.VBResizer.com

Forms/Controls Resizing/Tabbing

http://www.VBCompare.com

Compare Code

http://www.VBSortGen.com

Generate Sort Class in VB

http://www.Vbcompare.com/Check.Htm(1979

Check To MS)

 

[SharkTooth]

Thanks; do you have any information on how I generate the XML and/or where I can find it to include it in a distribution? Actually developers normally will just reference the DLL in their project, I wonder what the other step would be so they can get the help from the XML file.

Thanks for your help

 

[JohnYingling]

I have no such information at the moment. I have not had to distribute code that will be used by others yet.

http://www.VBResizer.com

Forms/Controls Resizing/Tabbing

http://www.VBCompare.com

Compare Code

http://www.VBSortGen.com

Generate Sort Class in VB

http://www.Vbcompare.com/Check.Htm(1979

Check To MS)

 

[chiph]

You have to set the option in the project build properties to tell the compiler to create the XML docs.

You just put the XML file in the same directory as the DLL.

Chip H.


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

 

[chiph]

You might also want to look at NDoc:

http://ndoc.sourceforge.net

It has the ability to turn your source comments into a HTML help file.

Chip H.


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