Intelisense Question

[Adam]

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

[James Jenkins]

"Adam" <Ad*****@shaw.ca> wrote in message
news:cqFSe.372158$s54.150520@pd7tw2no...

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)

{

[Adam]

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.ca> wrote in message
news:cqFSe.372158$s54.150520@pd7tw2no...

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)

{

[James Jenkins]

"Adam" <Ad*****@shaw.ca> wrote in message
news:qjHSe.373384$s54.347488@pd7tw2no...

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.ca> wrote in message
news:cqFSe.372158$s54.150520@pd7tw2no...

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

[omer kamal]

I am facing the same issue :(

regards,

Omer kamal

[Lasse Vågsæther Karlsen]

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 "Configuration 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***@vkarlsen.no
PGP KeyID: 0x2A42A1C2

[geoffblanduk_nospam]

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).

[Lasse Vågsæther Karlsen]

ge*****************@yahoo.co.uk 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***@vkarlsen.no
PGP KeyID: 0x2A42A1C2