473,672 Members | 2,703 Online
Bytes | Software Development & Data Engineering Community
+ Post

Home Posts Topics Members FAQ

Attribute for Methods and Parameters

How do you get the description appearing in Intellisense for methods and
parameters of methods? Does anyone have an example ?

Much appreciated
Kees
Sep 21 '07 #1
3 1124
Kees,

if you are using C#, just type /// on a line preceding the method
declaration (or ''' in VB 2005) - and VS will create a stub for you to fill
in with your description of the method and parameters if any.

"Kees de Winter" wrote:
How do you get the description appearing in Intellisense for methods and
parameters of methods? Does anyone have an example ?

Much appreciated
Kees
Sep 21 '07 #2
Hi Kees,

Kees de Winter schrieb:
How do you get the description appearing in Intellisense for methods and
parameters of methods? Does anyone have an example ?
Intellisense gets these descriptions from the XML-style comment which
Visual Studio creates automatically when you enter three slashes /// in
the line above the method declaration:

/// <summary>
/// This is the summary for myFunction.
/// </summary>
/// <param name="i">The description for the parameter i</param>
/// <returns>Descri bes the return value</returns>
public int myFunction(int i)
{
}

You can find additional tags on
http://msdn2.microsoft.com/en-us/lib...ax(VS.80).aspx

Hope this helps,

Roland
Sep 21 '07 #3
Perfect, thanks to all !
"Roland Dick" <br*****@web.de wrote in message
news:uz******** ******@TK2MSFTN GP06.phx.gbl...
Hi Kees,

Kees de Winter schrieb:
How do you get the description appearing in Intellisense for methods and
parameters of methods? Does anyone have an example ?

Intellisense gets these descriptions from the XML-style comment which
Visual Studio creates automatically when you enter three slashes /// in
the line above the method declaration:

/// <summary>
/// This is the summary for myFunction.
/// </summary>
/// <param name="i">The description for the parameter i</param>
/// <returns>Descri bes the return value</returns>
public int myFunction(int i)
{
}

You can find additional tags on
http://msdn2.microsoft.com/en-us/lib...ax(VS.80).aspx

Hope this helps,

Roland

Sep 21 '07 #4

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

Similar topics

5
4884
by: Fernando Rodriguez | last post by:
Hi, I have a base class with a 'sanity-check' method. This method should iterate through all the methods and check if they are all 'thunks' (zero parameter functions, well actually, 1 parameter: self). How can I access the list of methods of a given object? BTW, this class will be inherited from, so it should work with hte derived classes too. How can I check the number of parameters of a given function object?
7
2165
by: Doran_Dermot | last post by:
Hi All, I've seen lots of code in which the attributes of a class are accessed and modified using two separate methods. For example: class Problems: def __init__( self, refNum ): self._refNum = refNum self._title = "" self._problem = ""
1
2236
by: Mark | last post by:
Hi, Am trying to write custom validation attributes for public fields, properties, methods etc. using context-bound programming. It works fine for properties, methods, parameters etc. But, when intercepting a Set of a public field, there appears to be an underlying method set up; a FieldSetter, which take parameters type, fieldname and fieldvalue.
5
2224
by: Stuart Carnie | last post by:
I suspect it's unlikely, but you'll never know until you ask, but are there any attributes that would allow us to contribute to the compiled output? e.g. // this class exists in a separate, compiled assembly for the compiler to load during compilation class MyMethodCompiler : Attribute { // This is called during compilation public override void GenerateMethod(MethodBuilder method)
9
1503
by: Philipp | last post by:
Hello. OK I know this is the most asked question in XML (it says in some tutorial), but still. Please give me your insight on this (as I'm a newbie). I want to store parameters for a programm in an XML file. I can see 3 intelligent ways to this. 1) <?xml version="1.0" ?> <PARAMETERS>
6
3547
by: Adam Donahue | last post by:
As an exercise I'm attempting to write a metaclass that causes an exception to be thrown whenever a user tries to access 'attributes' (in the traditional sense) via a direct reference. Consider: class X( object ): y = 'private value' def get_y( self ): return self.y
3
297
by: kjell | last post by:
Hi, I wonder if someone may have a solution to a small problem I'm experiencing with a C++ program? I'm have two classes in my application that provides methods for setting parameters in the classes. These methods returns a pointer to the class itself so that you can use the return value to call another attribute setting method on the same line. This is what my program look like: #include <iostream>
5
2163
by: elbin | last post by:
Hello, first to say that I am a total beginner in Javascript but I know some programming (python in particular) and am able to understand methods/parameters and so on. Here's my problem: I am trying to set up a page that changes every time it's visited, but without using php(which i don't know either) because it's not active on the server. The thing that should change is a single number in one attribute of an <embed> tag inside an <object>....
6
2212
by: Tony Johansson | last post by:
Hello! Here I have a simple example of a custom defined Attribute class called CodeStatus. Now to my question when I debug this application and I set a breakpoint in the CodeStatus attribute class I will never enter that code. So what is the point in using attribute when the Attribute class is never executed. I have probably misunderstood something here about Attribute.
0
8500
marktang
by: marktang | last post by:
ONU (Optical Network Unit) is one of the key components for providing high-speed Internet services. Its primary function is to act as an endpoint device located at the user's premises. However, people are often confused as to whether an ONU can Work As a Router. In this blog post, we’ll explore What is ONU, What Is Router, ONU & Router’s main usage, and What is the difference between ONU and Router. Let’s take a closer look ! Part I. Meaning of...
0
8943
Oralloy
by: Oralloy | last post by:
Hello folks, I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>". The problem is that using the GNU compilers, it seems that the internal comparison operator "<=>" tries to promote arguments from unsigned to signed. This is as boiled down as I can make it. Here is my compilation command: g++-12 -std=c++20 -Wnarrowing bit_field.cpp Here is the code in...
1
8635
by: Hystou | last post by:
Overview: Windows 11 and 10 have less user interface control over operating system update behaviour than previous versions of Windows. In Windows 11 and 10, there is no way to turn off the Windows Update option using the Control Panel or Settings app; it automatically checks for updates and installs any it finds, whether you like it or not. For most users, this new feature is actually very convenient. If you want to control the update process,...
0
8695
tracyyun
by: tracyyun | last post by:
Dear forum friends, With the development of smart home technology, a variety of wireless communication protocols have appeared on the market, such as Zigbee, Z-Wave, Wi-Fi, Bluetooth, etc. Each protocol has its own unique characteristics and advantages, but as a user who is planning to build a smart home system, I am a bit confused by the choice of these technologies. I'm particularly interested in Zigbee because I've heard it does some...
0
7465
agi2029
by: agi2029 | last post by:
Let's talk about the concept of autonomous AI software engineers and no-code agents. These AIs are designed to manage the entire lifecycle of a software development project—planning, coding, testing, and deployment—without human intervention. Imagine an AI that can take a project description, break it down, write the code, debug it, and then launch it, all on its own.... Now, this would greatly impact the work of software developers. The idea...
0
5719
by: conductexam | last post by:
I have .net C# application in which I am extracting data from word file and save it in database particularly. To store word all data as it is I am converting the whole word file firstly in HTML and then checking html paragraph one by one. At the time of converting from word file to html my equations which are in the word document file was convert into image. Globals.ThisAddIn.Application.ActiveDocument.Select();...
0
4238
by: TSSRALBI | last post by:
Hello I'm a network technician in training and I need your help. I am currently learning how to create and manage the different types of VPNs and I have a question about LAN-to-LAN VPNs. The last exercise I practiced was to create a LAN-to-LAN VPN between two Pfsense firewalls, by using IPSEC protocols. I succeeded, with both firewalls in the same network. But I'm wondering if it's possible to do the same thing, with 2 Pfsense firewalls...
0
4437
by: adsilva | last post by:
A Windows Forms form does not have the event Unload, like VB6. What one acts like?
1
2835
by: 6302768590 | last post by:
Hai team i want code for transfer the data from one system to another through IP address by using C# our system has to for every 5mins then we have to update the data what the data is updated we have to send another system

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.