473,714 Members | 5,096 Online
Bytes | Software Development & Data Engineering Community
+ Post

Home Posts Topics Members FAQ

Intelisense Question

Hey Guys,

What I’m trying to do is find out how to put those nifty descriptions in
the intelisense popups.
What I mean is, you know when your using intelisens in VS after you type
the period the list of available methods, properties and objects is listed.
When you hover your mouse over an item it will pop up with the
parameters requires along with a brief description of what it does.
Is there a way for me to code that into my class library, so when I
reference it from another project I can use intelisens this way.

Any help or input would be greatly appreciated

- Adam
Nov 17 '05 #1
7 1486

"Adam" <Ad*****@shaw.c a> wrote in message
news:cqFSe.3721 58$s54.150520@p d7tw2no...
Hey Guys,

What I’m trying to do is find out how to put those nifty descriptions in
the intelisense popups.
What I mean is, you know when your using intelisens in VS after you type
the period the list of available methods, properties and objects is
listed.
When you hover your mouse over an item it will pop up with the parameters
requires along with a brief description of what it does.
Is there a way for me to code that into my class library, so when I
reference it from another project I can use intelisens this way.

Any help or input would be greatly appreciated

- Adam


Hi Adam,

within the code editor type 3 slashes /// - and a summary template will be
created for you - which you can customise as below -

/// <summary>

/// Starts an Interface

/// </summary>

/// <param name="NicName"> Returns the Name of an interface</param>

public void Start(string NicName)

{

Nov 17 '05 #2
Hi James,

First of all I would just like to thank you for your quick reply.

The thing is tho that this does not work for a class library that I
build and a reference to from a different project. I'm not sure if maybe
i'm not doing something right but heres what i tried.

namespace Testing
{
public class Test
{
/// <summary>
/// iunno if this part matters we will see
/// </summary>
/// <param name="something ">Testing to see if this works</param>
public int Something(int x,int y)
{
return x + y;
}
}
}

Then i compiled it and added a reference to a windows application.
When im in code view intellisense doesnt show either of the comments.
If someone can see something that im not doing or am doing wrong i would
appreciate your input

James Jenkins wrote:
"Adam" <Ad*****@shaw.c a> wrote in message
news:cqFSe.3721 58$s54.150520@p d7tw2no...
Hey Guys,

What I’m trying to do is find out how to put those nifty descriptions in
the intelisense popups.
What I mean is, you know when your using intelisens in VS after you type
the period the list of available methods, properties and objects is
listed.
When you hover your mouse over an item it will pop up with the parameters
requires along with a brief description of what it does.
Is there a way for me to code that into my class library, so when I
reference it from another project I can use intelisens this way.

Any help or input would be greatly appreciated

- Adam

Hi Adam,

within the code editor type 3 slashes /// - and a summary template will be
created for you - which you can customise as below -

/// <summary>

/// Starts an Interface

/// </summary>

/// <param name="NicName"> Returns the Name of an interface</param>

public void Start(string NicName)

{

Nov 17 '05 #3

"Adam" <Ad*****@shaw.c a> wrote in message
news:qjHSe.3733 84$s54.347488@p d7tw2no...
Hi James,

First of all I would just like to thank you for your quick reply.

The thing is tho that this does not work for a class library that I build
and a reference to from a different project. I'm not sure if maybe i'm not
doing something right but heres what i tried.

namespace Testing
{
public class Test
{
/// <summary>
/// iunno if this part matters we will see
/// </summary>
/// <param name="something ">Testing to see if this works</param>
public int Something(int x,int y)
{
return x + y;
}
}
}

Then i compiled it and added a reference to a windows application.
When im in code view intellisense doesnt show either of the comments.
If someone can see something that im not doing or am doing wrong i would
appreciate your input

James Jenkins wrote:
"Adam" <Ad*****@shaw.c a> wrote in message
news:cqFSe.3721 58$s54.150520@p d7tw2no...
Hey Guys,

What I’m trying to do is find out how to put those nifty descriptions in
the intelisense popups.
What I mean is, you know when your using intelisens in VS after you type
the period the list of available methods, properties and objects is
listed.
When you hover your mouse over an item it will pop up with the parameters
requires along with a brief description of what it does.
Is there a way for me to code that into my class library, so when I
reference it from another project I can use intelisens this way.

Any help or input would be greatly appreciated

- Adam

Hi Adam,

within the code editor type 3 slashes /// - and a summary template will
be created for you - which you can customise as below -

/// <summary>

/// Starts an Interface

/// </summary>

/// <param name="NicName"> Returns the Name of an interface</param>

public void Start(string NicName)

{


hi, - try going to the Project Properties and set the 'Xml Documentation
File' in - Configuration Properties - > Build - > Outputs
Nov 17 '05 #4
I am facing the same issue :(

regards,

Omer kamal
Nov 17 '05 #5
omer kamal wrote:
I am facing the same issue :(

regards,

Omer kamal


To get intellisense working from C# XML Documentation in a separate
assembly, do the following:

1. Go to the Properties dialog for your C# assembly project (the class
library that contain the XML documentation)
2. Go to the section named "Configurat ion Properties" and "Build"
sub-section
3. Find the value named "XML Documentation File"
4. Type in the name of the XML file you want to generate. This should be
the same name as the compiled assembly file, except it should have a
..xml extension.

After compiling you should have a .xml file alongside your .dll with the
complete XML documentation from your assembly. If you don't have a .xml
file, check your settings once more and if nothing works, you'll just
have to post a new question here.

In the project using the assembly you *might* have to re-add the
reference to the assembly but I doubt it. Reopening the project might be
enough.

--
Lasse Vågsæther Karlsen
http://www.vkarlsen.no/
mailto:la***@vk arlsen.no
PGP KeyID: 0x2A42A1C2
Nov 17 '05 #6
I think your "other" project needs to be able to access the XML doc
file too.
Once the dll and xml files are built, easiest thing to do is to ship
the xml file with the dll (so for example, store the xml file in the
same directory your "other project" is picking the dll up from).

Nov 17 '05 #7
ge************* ****@yahoo.co.u k wrote:
I think your "other" project needs to be able to access the XML doc
file too.
Once the dll and xml files are built, easiest thing to do is to ship
the xml file with the dll (so for example, store the xml file in the
same directory your "other project" is picking the dll up from).


Yes, that is correct, if you don't add a reference to the assembly from
the location it was compiled to, remember to copy the .xml file
alongside the .dll wherever you copy the .dll file and it should work.

--
Lasse Vågsæther Karlsen
http://www.vkarlsen.no/
mailto:la***@vk arlsen.no
PGP KeyID: 0x2A42A1C2
Nov 17 '05 #8

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

Similar topics

2
1299
by: Eric | last post by:
Hello, I'm sure there's an easy answer for this but I can't seem to figure out why VS is behaving this way. If I create a new ASP.net project, the codebehind VB file allows me to type in the name of a control and when I hit the period all the respective methods and attributes come up for that object (isn't that intelisense?). But, If I try to create a single ASPX file with VB code inline using visual studio, the code itself does not use...
6
1701
by: Mark | last post by:
Hi, When you view the definitions of standard methods/properties in intelisense as well as the basic definition you get a brief description, for example for string.length you see "Gets the number of characters in this instance". Is it possible to add this to my own methods & properties? Thanks,
2
291
by: Eric | last post by:
Hello, I'm sure there's an easy answer for this but I can't seem to figure out why VS is behaving this way. If I create a new ASP.net project, the codebehind VB file allows me to type in the name of a control and when I hit the period all the respective methods and attributes come up for that object (isn't that intelisense?). But, If I try to create a single ASPX file with VB code inline using visual studio, the code itself does not use...
2
1267
by: =?Utf-8?B?Y2FsZGVyYXJh?= | last post by:
Dear all, I come from VB.net world and I start with C#now due to customer demand :-( I was used undeer VB that as long as you type the AS ( to define the type of your variable) the intelisense pops up with all data type, which easy when you do not remember a type you are not using so frequently...and its fast to catch it. Now in c#, the type need to be specify first and then your variables. The only way to get the intellisense pop up...
0
8712
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
9316
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
9077
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
7954
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
6638
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
5959
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
4729
by: adsilva | last post by:
A Windows Forms form does not have the event Unload, like VB6. What one acts like?
2
2525
muto222
by: muto222 | last post by:
How can i add a mobile payment intergratation into php mysql website.
3
2113
bsmnconsultancy
by: bsmnconsultancy | last post by:
In today's digital era, a well-designed website is crucial for businesses looking to succeed. Whether you're a small business owner or a large corporation in Toronto, having a strong online presence can significantly impact your brand's success. BSMN Consultancy, a leader in Website Development in Toronto offers valuable insights into creating effective websites that not only look great but also perform exceptionally well. In this comprehensive...

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.