473,327 Members | 1,919 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,327 software developers and data experts.

Make library module comments appear in object browser

I'm making a C# library module that has methods & properties that I've
commented. I would like these comments to appear in the object browser when
the library is used by another .NET application.

The documentation is pretty thin describing this feature. All I could find
was a reference to using XML documentation techniques; specifically using
the "///" comment. I tried this but it didn't work.

Any ideas? Thanks.

Gary ...

Nov 15 '05 #1
3 1886

"Gary James" <ga***@iotech.com> wrote in message
news:%2****************@tk2msftngp13.phx.gbl...
I'm making a C# library module that has methods & properties that I've
commented. I would like these comments to appear in the object browser when the library is used by another .NET application.

The documentation is pretty thin describing this feature. All I could find was a reference to using XML documentation techniques; specifically using
the "///" comment. I tried this but it didn't work.

Any ideas? Thanks.

Gary ...


You're halfway there. Writing the "///" comments is the first step.
The next step is going to the project-properties and under Configuration
Properties | Build enter a value for "Xml Documentation File"
(usual seems to be: same directory as debug output path, filename
same as project name, extension ".xml")
Then a rebuild and you are set.

Hans Kesting
Nov 15 '05 #2
Please read this snippet:
/// <summary>
/// ExecuteNonQuery Operation,Manual Transaction
/// </summary>
/// <param name="conn">SqlConnection</param>
/// <param name="trans">SqlTransaction</param>
/// <param name="commandType">CommandType </param>
/// <param name="commandText">CommandText:just like Sql
code and so on</param>
/// <param name="param">Sql Parameter</param>
/// <returns></returns>
public int ExecuteNonQuery(SqlConnection
conn,SqlTransaction trans,CommandType commandType,string
commandText,params SqlParameter[] param)
{
_affectRows=0;

SqlCommand cmd=new SqlCommand();
try
{

PrepareCommand
(cmd,conn,trans,commandType,commandText,param);

_affectRows=cmd.ExecuteNonQuery();
trans.Commit();
}
catch(Exception ex)
{
_affectRows=-2;
trans.Rollback();
OnnonQueryEvent(this,ex);
throw ex;

}
finally
{
cmd.Dispose();
cmd=null;
}
return _affectRows;
}
Nov 15 '05 #3
http://msdn.microsoft.com/library/de...onComments.asp

go to the part where it says To set this compiler option in the Visual
Studio development environment

I don't think you made your library write the documentation to file.

"Gary James" <ga***@iotech.com> wrote in message
news:%2****************@tk2msftngp13.phx.gbl...
I'm making a C# library module that has methods & properties that I've
commented. I would like these comments to appear in the object browser when the library is used by another .NET application.

The documentation is pretty thin describing this feature. All I could find was a reference to using XML documentation techniques; specifically using
the "///" comment. I tried this but it didn't work.

Any ideas? Thanks.

Gary ...

Nov 15 '05 #4

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

21
by: William Stacey [MVP] | last post by:
Anyone know of some library that will parse files like following: options { directory "/etc"; allow-query { any; }; // This is the default recursion no; listen-on { 192.168.0.225;...
6
by: Eric | last post by:
for example: SqlConnection is used in my project, how can I know if all connections were closed after open and execution. If some guys forget to close connections after using, how can i check it...
4
by: SR | last post by:
I've been trying to find out how to get comments to appear in the 'Object Browser' for my VB.Net components. What a nightmare!! I've created the XML Code document, so when I reference the...
6
by: scottyman | last post by:
I can't make this script work properly. I've gone as far as I can with it and the rest is out of my ability. I can do some html editing but I'm lost in the Java world. The script at the bottom of...
7
by: Steven Bethard | last post by:
I've updated PEP 359 with a bunch of the recent suggestions. The patch is available at: http://bugs.python.org/1472459 and I've pasted the full text below. I've tried to be more explicit about...
19
by: zzw8206262001 | last post by:
Hi,I find a way to make javescript more like c++ or pyhon There is the sample code: function Father(self) //every contructor may have "self" argument { self=self?self:this; ...
4
by: Joel Andres Granados | last post by:
Hi list: I have run across a situation with ConfigParser Module. It refers to the comments in the configuration filed. According to the http://docs.python.org/dev/lib/module-ConfigParser.html...
3
by: Brian | last post by:
Hi, I am trying to format my comments for my class library. how do i insert new line feed so that all the text is not just jumbled in together Brian
1
KevinADC
by: KevinADC | last post by:
Note: You may skip to the end of the article if all you want is the perl code. Introduction Many websites have a form or a link you can use to download a file. You click a form button or click...
0
by: DolphinDB | last post by:
Tired of spending countless mintues downsampling your data? Look no further! In this article, you’ll learn how to efficiently downsample 6.48 billion high-frequency records to 61 million...
0
by: ryjfgjl | last post by:
ExcelToDatabase: batch import excel into database automatically...
0
by: Vimpel783 | last post by:
Hello! Guys, I found this code on the Internet, but I need to modify it a little. It works well, the problem is this: Data is sent from only one cell, in this case B5, but it is necessary that data...
0
by: jfyes | last post by:
As a hardware engineer, after seeing that CEIWEI recently released a new tool for Modbus RTU Over TCP/UDP filtering and monitoring, I actively went to its official website to take a look. It turned...
0
by: ArrayDB | last post by:
The error message I've encountered is; ERROR:root:Error generating model response: exception: access violation writing 0x0000000000005140, which seems to be indicative of an access violation...
1
by: CloudSolutions | last post by:
Introduction: For many beginners and individual users, requiring a credit card and email registration may pose a barrier when starting to use cloud servers. However, some cloud server providers now...
0
by: af34tf | last post by:
Hi Guys, I have a domain whose name is BytesLimited.com, and I want to sell it. Does anyone know about platforms that allow me to list my domain in auction for free. Thank you
0
by: Faith0G | last post by:
I am starting a new it consulting business and it's been a while since I setup a new website. Is wordpress still the best web based software for hosting a 5 page website? The webpages will be...
0
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 3 Apr 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM). In this session, we are pleased to welcome former...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.