473,320 Members | 2,006 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,320 software developers and data experts.

QuickInfo method description

How do you add a comment description to your functions and properties so
that they will show up when you use the Intellisense QuickInfo or member
list?

I've tried regular C++ comments but that didn't work.
ex.
//Dump test function
void MyFunc(int value)
{
....
}

I've also tried regular C++ comments this way.ex.
void MyFunc(int value) //Dump test function
{
....
}

Please help!!
Nov 16 '05 #1
2 6706
I am sure this should look familiar to you:

/// <summary>
/// Adds string to collection.
/// </summary>
/// <remarks>
/// This is a remark.
/// </remarks>
/// <param name="str">The ostring you want to add.</param>
public void AddString(string str)
{
// implementation
}

They are called xml documentation, you could search msdn for that to get
familiar with all possible xml elements that you can use.
Ultimately, you can use this kind of code documentation to generate
msdn-like documentation for your code.
Also, you can use tools like NDoc to generate the
latter.(http://ndoc.sourceforge.net/)
"Relaxin" <me@yourhouse.com> wrote in message
news:uh*************@tk2msftngp13.phx.gbl...
How do you add a comment description to your functions and properties so
that they will show up when you use the Intellisense QuickInfo or member
list?

I've tried regular C++ comments but that didn't work.
ex.
//Dump test function
void MyFunc(int value)
{
...
}

I've also tried regular C++ comments this way.ex.
void MyFunc(int value) //Dump test function
{
...
}

Please help!!

Nov 16 '05 #2
I am familiar with this, but by doing this, it still does NOT show up in the
QuickInfo.
"hOSAM" <hosam.shahin$$gmail.com> wrote in message
news:uo**************@TK2MSFTNGP11.phx.gbl...
I am sure this should look familiar to you:

/// <summary>
/// Adds string to collection.
/// </summary>
/// <remarks>
/// This is a remark.
/// </remarks>
/// <param name="str">The ostring you want to add.</param>
public void AddString(string str)
{
// implementation
}

They are called xml documentation, you could search msdn for that to get
familiar with all possible xml elements that you can use.
Ultimately, you can use this kind of code documentation to generate
msdn-like documentation for your code.
Also, you can use tools like NDoc to generate the
latter.(http://ndoc.sourceforge.net/)
"Relaxin" <me@yourhouse.com> wrote in message
news:uh*************@tk2msftngp13.phx.gbl...
How do you add a comment description to your functions and properties so
that they will show up when you use the Intellisense QuickInfo or member
list?

I've tried regular C++ comments but that didn't work.
ex.
//Dump test function
void MyFunc(int value)
{
...
}

I've also tried regular C++ comments this way.ex.
void MyFunc(int value) //Dump test function
{
...
}

Please help!!


Nov 16 '05 #3

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

Similar topics

1
by: Paul | last post by:
Hi I'm implementing a few COM classes using Python. I've come across a problem when I'm trying the return an instance of a class from a method on one of my classes. The code is as follows,...
18
by: Jon S via DotNetMonster.com | last post by:
Hi all, I searching a string to see if "Desc" resides in it, if so then replace it with "Description". For some reason if it finds "Desc" in the word "Description" it replaces the "Desc" part...
12
by: Rubbrecht Philippe | last post by:
Hi there, According to documentation I read the ArrayList.IndexOf method uses the Object.Equals method to loop through the items in its list and locate the first index of an item that returns...
8
by: John Cobb | last post by:
Excuse me if I use some terminology incorrectly as I am not well versed in Object Orientation. In short I want to create an Enumerated type similar to the following Enum Monitor as Byte Small...
3
by: jbsfe | last post by:
I have "Spilt" my database and the "lookup" and "seek" methods that previously worked, no longer do. I have learnd from reviewing the posts that the "lookup" and "Seek" methods cannot be used on...
4
by: Alan T | last post by:
I got a method in my ancestor form declared as Protected, this method has empty body. In my descendant form I declared as Protected also, then compile has no problem but the name of the method has...
0
by: compumate99 | last post by:
I am trying to parse the xml document using selectsinglenode method. I am doing this using Visual Foxpro >>> loResultXml = CreateObject("Microsoft.XMLDOM") With loResultXml .Async = .F. ...
1
by: clemenslinders | last post by:
Adding comments aka QuickInfo to intellisense: On this forum I found in it's history the following thread: http://www.thescripts.com/forum/thread254408.html Someone also wanted to add comments...
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
isladogs
by: isladogs | last post by:
The next Access Europe meeting will be on Wednesday 6 Mar 2024 starting at 18:00 UK time (6PM UTC) and finishing at about 19:15 (7.15PM). In this month's session, we are pleased to welcome back...
1
isladogs
by: isladogs | last post by:
The next Access Europe meeting will be on Wednesday 6 Mar 2024 starting at 18:00 UK time (6PM UTC) and finishing at about 19:15 (7.15PM). In this month's session, we are pleased to welcome back...
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...
0
by: Defcon1945 | last post by:
I'm trying to learn Python using Pycharm but import shutil doesn't work
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.