473,799 Members | 3,212 Online
Bytes | Software Development & Data Engineering Community
+ Post

Home Posts Topics Members FAQ

Descriptive Intellisense?

Platform : Asp.Net/C#, Framework 1.1
--------------------------------------------

I have many overloads of constructors/other methods in most of my classes.
I want to provide some descriptive help when people cosume such classes,
just like MS does say when I say :

new DataSet(
and I get a list of constructors, along with a description of constructor,
and paramter in the second line.

The kind of comments I have right now are:

/// <summary>
/// This Constructor is to be used when a new Stage is being created
/// </summary>
/// <param name="ownerid"> Owner ID</param>
/// <param name="stageid"> Stage Identifier, Not recycled for an
owner</param>
/// <param name="processid ">Process Identifier, recycle for each
Owner</param>

public ProcessStageInf o(int ownerid, int stageid, int processid)
{//......}

Can somebody suggest how this is possible? Basically what I want to know is
how to get the descriptive second line after the constructor list.

Manish
Nov 15 '05 #1
1 1463
Manish,
Figured it out!! :DD Try typing three "/"'s just before each overloaded
function/method. It should autmatically create a short XML Documentation
block of code in which you can decribe each parameter, etc. Check out the
following code:

private void button1_Click(o bject sender, System.EventArg s e)
{
MyFunc(<Descrip tive Intellisense shows up here>
}

/// <summary>
/// This is the First one
/// </summary>
/// <param name="Counter"> Integer to Count how many there are</param>
/// <param name="Quickness ">String to describe how quickly it is</param>
private void MyFunc(Int32 Counter, String Quickness)
{
MessageBox.Show ("This is the First One");
}

/// <summary>
/// This is the Second one
/// </summary>
/// <param name="Counter"> How many there are</param>
private void MyFunc(Int32 Counter)
{
MessageBox.Show ("This is the Second One")'
}

Let me know how you go.

Rob Manger
ro**@devtest.co m
Nov 15 '05 #2

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

Similar topics

8
2406
by: andrew.queisser | last post by:
Yesterday I typed in some C++ code that called a function with two ints. Intellisense (auto-complete) helpfully told me that the first formal parameter was called "frontLight" and the second "ringLight". It occurred to me that I'm getting some semantic help here on top of the obvious type safety. It seems to me that the existance of this kind of support is tied to the static typing nature of C++. I've always been interested in the...
6
8100
by: Stefan Kronberg | last post by:
I'm working on a solution containing about 20 projects. Some of the projects contain class definitions that are used in other of the projects. Most of the time intellisense is working ok, i.e. if I work with objects declared from my own classes intellisense will show me all alternatives (methods and properties from my classes and from the classes they are derived from). But sometimes I will get nothing from intellisense, completely nothing,...
1
2212
by: Christopher W. Douglas | last post by:
I'm working in VB.Net, using Visual Studio 2003. I have a project, let's call it Foo, that contains common methods, forms, and objects I use in other projects. It compiles as Foo.dll, which I then reference from the project that needs it. Let's say I have a method, Bar, that I want to access from another project. If I add a public module Methods to Foo, and add a public method Bar to Methods, I can call it from my other project a...
0
279
by: Manish Jain | last post by:
Platform : Asp.Net/C#, Framework 1.1 -------------------------------------------- I am using Petshop suggested Architecture for my web app. I have many overloads of constructors/other methods in most of my classes. I want to provide some descriptive help when people cosume such classes, just like MS does say when I say : new DataSet( and I get a list of constructors, along with a description of constructor,
0
1331
by: Jim | last post by:
I had a strange problem the other day when using Intellisense, and wondering if anyone has any experience with or advice on this... Just to give some quick background, I have a multi-tier application, with business objects coded in a business layer (C# project), the service interfaces and service objects coded in two C# projects, respectively. In my service objects project, I go to call on one of the
1
1897
by: Yaron | last post by:
Hi, I have a custom ListView-type control that I designed a few months ago. The control is completely stable and functional. However, often, the Visual Studio .NET IDE's Intellisense will lose and not display members not contained inside of Control (which my control is inherited from). Despite this, program execution still works fine; Intellisense just stops displaying these members, is all. If I close down Visual Studio and open it again,...
12
4838
by: Peteroid | last post by:
I was creating my application just fine for the last 3 weeks or so. Then, starting this morning, IntelliSense seems to be having problems. It goes into a locked 'Updating IntelliSense..." mode. When this happens its time to close VS C++.NET, which can only be done via the Windows Task Manager. I tried repairing C++. It did seem to help, but the problem is back a few hours later. I will try creating a new project, copy over source files,...
5
3251
by: wal | last post by:
Hello, I'm using __declspec(property) to access get/set methods as properties (like in C# and VB.NET). Now, the problem is that both the property name and the get/set methods show in the intellisense list. Is there anyway to remove the names of the get/set methods from the intellisense list? Here's an example, I have two methods, one is a get method with the name getText and another set method with the name setText, the name of the...
3
340
by: Travis | last post by:
Hi, I was a user of Visual C# for a while and have gotten used to the Intellisense for that program. I went to try Visual Basic, and the intellisense is so much different. I'll try to make an example: Say I want to write: MessageBox.Show("Hi there") In C#, once I type just a single "M," everything (objects, classes, everything) that begins with M will appear in the intellisense list. Once you get to "Mes" MessageBox will be selected...
0
9541
by: Hystou | last post by:
Most computers default to English, but sometimes we require a different language, especially when relocating. Forgot to request a specific language before your computer shipped? No problem! You can effortlessly switch the default language on Windows 10 without reinstalling. I'll walk you through it. First, let's disable language synchronization. With a Microsoft account, language settings sync across devices. To prevent any complications,...
0
10252
jinu1996
by: jinu1996 | last post by:
In today's digital age, having a compelling online presence is paramount for businesses aiming to thrive in a competitive landscape. At the heart of this digital strategy lies an intricately woven tapestry of website design and digital marketing. It's not merely about having a website; it's about crafting an immersive digital experience that captivates audiences and drives business growth. The Art of Business Website Design Your website is...
0
10027
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
9073
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...
1
7565
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 1 May 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 a new presenter, Adolph Dupré who will be discussing some powerful techniques for using class modules. He will explain when you may want to use classes instead of User Defined Types (UDT). For example, to manage the data in unbound forms. Adolph will...
0
6805
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
5463
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
5585
by: adsilva | last post by:
A Windows Forms form does not have the event Unload, like VB6. What one acts like?
2
3759
muto222
by: muto222 | last post by:
How can i add a mobile payment intergratation into php mysql website.

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.