Comments in .NET dll

Thread view:

Enable EMail Alerts

Start New Thread

Thread rating:

Mantas Miliukas - 26 Jan 2006 06:18 GMT

Hi,

I have a problem with comments in .NET dlls.
Here is the situation:

We have a single solution (S). The solution contains 2 projects (P1 and P2).
When writing code within project P1, we use .NET comments. For example:

/// <summary>
/// Determines the start point of parsing and starts the parser.
/// </summary>
/// <param name="p"></param>
protected void Execute(Parser p)
{
...
}

The second project P2 references the classes declared in the first project.
However, the intellisence doesn't display the comments on classes and
methods.
Intellisence works only with classes and methods declared in current
project.

Is there any way to see the comments?

Thanks in advance,
Mantas Miliukas

Reply to this Message

Jon Shemitz - 26 Jan 2006 07:03 GMT

> We have a single solution (S). The solution contains 2 projects (P1 and P2).
> When writing code within project P1, we use .NET comments. For example:
>
> /// <summary>

> The second project P2 references the classes declared in the first project.
> However, the intellisence doesn't display the comments on classes and
> methods.
> Intellisence works only with classes and methods declared in current
> project.

Set the "XML Documentation file" in the project's properties.

Signature

<http://www.midnightbeach.com>

Reply to this Message

Mantas Miliukas - 26 Jan 2006 08:10 GMT

Hi,

Your suggested solution only generates the xml file.
But intelisence doesn't work. Perhaps i should change some other settings?

Best regards,
Mantas Miliukas

>> We have a single solution (S). The solution contains 2 projects (P1 and
>> P2).
[quoted text clipped - 10 lines]
>
> Set the "XML Documentation file" in the project's properties.

Reply to this Message

"Peter Huang" [MSFT] - 26 Jan 2006 08:18 GMT

Hi Mantas,

You can take a look at the link below to generate a XML file for the dll.
XML Documentation Tutorial
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/csref/html/
vcwlkxmldocumentationtutorial.asp

/doc (Process Documentation Comments)
To use the generated .xml file for use with the IntelliSense feature, let
the file name of the .xml file be the same as the assembly you want to
support and then make sure the .xml file is in the same directory as the
assembly. Thus, when the assembly is referenced in the Visual Studio
project, the .xml file is found as well.

/doc will be ignored in a compilation that uses /incremental; use
/incremental- to ensure that file is up to date.
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cscomp/html
/vcerrDocProcessDocumentationComments.asp

Best regards,

Peter Huang
Microsoft Online Partner Support

Signature

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

Reply to this Message

Jon Shemitz - 26 Jan 2006 21:29 GMT

> To use the generated .xml file for use with the IntelliSense feature, let
> the file name of the .xml file be the same as the assembly you want to
> support and then make sure the .xml file is in the same directory as the
> assembly. Thus, when the assembly is referenced in the Visual Studio
> project, the .xml file is found as well.

Seems like a really bad design, actually. Why isn't there just a check
box that says something like "generate xml to support Intellisense"?
Then we wouldn't have people using VS for months or years before they
figure out how to get XML Doc to work across assemblies.

If there IS really some valid reason to name the XML something besides
assemblyName.xml, then the check box could be a radio button, and the
other alternatives would be "don't generate XML doc" and "generate XML
doc under weird name", which would be next to the weird name text box
....

Signature

<http://www.midnightbeach.com>

Reply to this Message

"Peter Huang" [MSFT] - 27 Jan 2006 02:22 GMT

Hi

The XML commnents is firstly introduced in Visual C# 2003.
In addition to Intellisense, XML Comments will be used to build help file
and so on.

Based on my test, the Intellisense will be improved in the Whidbey version,
VS.NET 2005.
You may have a try.

Best regards,

Peter Huang
Microsoft Online Partner Support

Signature

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

Reply to this Message

Comments in .NET dll

Free Magazines