Extended info for parameters in intellisense

[ken busse]

I have seen this from time to time when using different
components. How do I do this? Do I use Attributes and if
so do you have an example?
The information I am speaking about is may be an extra
sentence or so long underneath the usual parameter info.

 

[Peter Vrenken]

You mean something like the following?

/// <summary>
/// This is the extended information
/// </summary>
/// <param name="NetworkPacket">this is parameter one</param>
/// <param name="TargetPeer">this is parameter two</param>
internal void Send(NetworkPacket NetworkPacket, PeerID TargetPeer)
{
}

try entering three slashes (///) one line before a complete method
definition...

Peter Vrenken.

 

[Peter Vrenken]

Im sorry, just found this in the manual:

Code comments refer to comments placed in source code files that are then
available to users of the Visual Studio .NET development environment via the
IntelliSense feature.

[Visual Basic]
Visual Basic does not support code comments.

[C#]
You can use the XML Documentation feature to comment code. These comments
will be displayed through the List Members option.

[C++]
By default, any comments in the source code that use the // or /* delimiters
are displayed next to their associated member in the Members list. As you
scroll through the list, IntelliSense displays up to 12 lines of the comment
in a pop-up window next to the highlighted member.

When more than one comment exists for a function, IntelliSense determines
which comment to display in the Members list by where it appears in the
code:

1.. IntelliSense will first display end-of-line comments in the
declaration. For example:
void MyFunction(); //EOL declaration comments2.. If IntelliSense does not
find the previous type of comment, it will display comments that appear
directly above the declaration with no blank lines in between. For example:
//Before declaration comments
void MyFunction();3.. If the previous two types of comments are not found
in the code, IntelliSense will display end-of-line comments in the
definition. For example:
int CMyAppDoc::MyVariable=2; // EOL definition comments4.. Finally, if none
of the previous types of comments appear in the code, IntelliSense will
display comments that appear directly above the definition with no blank
lines in between. For example:
//Before definition comments
CMyAppDoc::MyFunction()
{
return;
}If you really want to comment your code you might think about a wrapper
class written in c#. There you could insert your comments etc.

Greetings from the Netherlands

----- Original Message -----
From: "Ken Busse" <[email protected]>
To: "Peter Vrenken" <[email protected]>
Sent: Monday, September 08, 2003 9:52 PM
Subject: Re: Extended info for parameters in intellisense

 

[Yan-Hong Huang[MSFT]]

Hello Ken,

For VB.NET, we have a specific tool for generating XML comments.

The XML Documentation Tool (XML Documentation Tool.exe) gives Visual Basic
..NET developers the ability to author XML documentation files for their
library projects. This is useful when it is desirable to distribute a built
assembly but impractical to distribute associated source code. Consumers of
their referenced libraries see the XML information in Intellisense in the
Visual Studio code editor and the Object Browser.

Please refer to
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dnvssamp/ht
ml/vbcs_XMLComments.asp for this tool.

For more information on VB.NET language features, I suggest you refer to
http://www.gotdotnet.com/team/vb/.

Does that answer your question?

Best regards,
Yanhong Huang
Microsoft Online Partner Support

Get Secure! - www.microsoft.com/security
This posting is provided "AS IS" with no warranties, and confers no rights.

--------------------
!Content-Class: urn:content-classes:message
!From: "ken busse" <[email protected]>
!Sender: "ken busse" <[email protected]>
!Subject: Extended info for parameters in intellisense
!Date: Mon, 8 Sep 2003 08:32:33 -0700
!Lines: 5
!Message-ID: <[email protected]>
!MIME-Version: 1.0
!Content-Type: text/plain;
! charset="iso-8859-1"
!Content-Transfer-Encoding: 7bit
!X-Newsreader: Microsoft CDO for Windows 2000
!X-MimeOLE: Produced By Microsoft MimeOLE V5.50.4910.0300
!Thread-Index: AcN2HmwxhgRi+wNkTnSgJzgwhza2Ng==
!Newsgroups: microsoft.public.dotnet.framework
!Path: cpmsftngxa06.phx.gbl
!Xref: cpmsftngxa06.phx.gbl microsoft.public.dotnet.framework:53204
!NNTP-Posting-Host: TK2MSFTNGXA09 10.40.1.161
!X-Tomcat-NG: microsoft.public.dotnet.framework
!
!I have seen this from time to time when using different
!components. How do I do this? Do I use Attributes and if
!so do you have an example?
!The information I am speaking about is may be an extra
!sentence or so long underneath the usual parameter info.
!

 

[ken busse]

Can't find the tool discussed in the article you mentioned
below. The article starts off as:
"To start the tool

Start the XML Documentation Tool by double-clicking XML
Documentation Tool.exe from its downloaded location. "

But there's no link, can't find it in the MSDN CD docs, or
on MSDN online.
Where is it?
Thanks,
Ken

 

[Yan-Hong Huang[MSFT]]

Hello Ken,

Thanks for your reply.

Please go to
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dnvssamp/ht
ml/vbcs_XMLComments.asp. There should be a link just below the title of
this article. "Download the XMLComments.exe sample."

We could download the exe file by clicking this link.

Please post here if you still can't find the file.

Best regards,
Yanhong Huang
Microsoft Online Partner Support

Get Secure! - www.microsoft.com/security
This posting is provided "AS IS" with no warranties, and confers no rights.

--------------------
!Content-Class: urn:content-classes:message
!From: "ken busse" <[email protected]>
!Sender: "ken busse" <[email protected]>
!References: <[email protected]>
<[email protected]>
!Subject: RE: Extended info for parameters in intellisense
!Date: Wed, 10 Sep 2003 07:50:36 -0700
!Lines: 82
!Message-ID: <[email protected]>
!MIME-Version: 1.0
!Content-Type: text/plain;
! charset="iso-8859-1"
!Content-Transfer-Encoding: 7bit
!X-Newsreader: Microsoft CDO for Windows 2000
!X-MimeOLE: Produced By Microsoft MimeOLE V5.50.4910.0300
!Thread-Index: AcN3quTch3kF60xdQTmT1b9E7YQ4fA==
!Newsgroups: microsoft.public.dotnet.framework
!Path: cpmsftngxa06.phx.gbl
!Xref: cpmsftngxa06.phx.gbl microsoft.public.dotnet.framework:53371
!NNTP-Posting-Host: TK2MSFTNGXA09 10.40.1.161
!X-Tomcat-NG: microsoft.public.dotnet.framework
!
!Can't find the tool discussed in the article you mentioned
!below. The article starts off as:
!"To start the tool
!
!Start the XML Documentation Tool by double-clicking XML
!Documentation Tool.exe from its downloaded location. "
!
!But there's no link, can't find it in the MSDN CD docs, or
!on MSDN online.
!Where is it?
!Thanks,
!Ken
!
!
!>-----Original Message-----
!>Hello Ken,
!>
!>For VB.NET, we have a specific tool for generating XML
!comments.
!>
!>The XML Documentation Tool (XML Documentation Tool.exe)
!gives Visual Basic
!>.NET developers the ability to author XML documentation
!files for their
!>library projects. This is useful when it is desirable to
!distribute a built
!>assembly but impractical to distribute associated source
!code. Consumers of
!>their referenced libraries see the XML information in
!Intellisense in the
!>Visual Studio code editor and the Object Browser.
!>
!>Please refer to
!>http://msdn.microsoft.com/library/default.asp?
!url=/library/en-us/dnvssamp/ht
!>ml/vbcs_XMLComments.asp for this tool.
!>
!>For more information on VB.NET language features, I
!suggest you refer to
!>http://www.gotdotnet.com/team/vb/.
!>
!>Does that answer your question?
!>
!>Best regards,
!>Yanhong Huang
!>Microsoft Online Partner Support
!>
!>Get Secure! - www.microsoft.com/security
!>This posting is provided "AS IS" with no warranties, and
!confers no rights.
!>
!>--------------------
!>!Content-Class: urn:content-classes:message
!>!From: "ken busse" <[email protected]>
!>!Sender: "ken busse" <[email protected]>
!>!Subject: Extended info for parameters in intellisense
!>!Date: Mon, 8 Sep 2003 08:32:33 -0700
!>!Lines: 5
!>!Message-ID: <[email protected]>
!>!MIME-Version: 1.0
!>!Content-Type: text/plain;
!>! charset="iso-8859-1"
!>!Content-Transfer-Encoding: 7bit
!>!X-Newsreader: Microsoft CDO for Windows 2000
!>!X-MimeOLE: Produced By Microsoft MimeOLE V5.50.4910.0300
!>!Thread-Index: AcN2HmwxhgRi+wNkTnSgJzgwhza2Ng==
!>!Newsgroups: microsoft.public.dotnet.framework
!>!Path: cpmsftngxa06.phx.gbl
!>!Xref: cpmsftngxa06.phx.gbl
!microsoft.public.dotnet.framework:53204
!>!NNTP-Posting-Host: TK2MSFTNGXA09 10.40.1.161
!>!X-Tomcat-NG: microsoft.public.dotnet.framework
!>!
!>!I have seen this from time to time when using different
!>!components. How do I do this? Do I use Attributes and if
!>!so do you have an example?
!>!The information I am speaking about is may be an extra
!>!sentence or so long underneath the usual parameter info.
!>!
!>
!>.
!>
!