|
dev
newsgroups
|
|||||||||||||||||||||||
|
|||||||||||||||||||||||
DescriptionAttributeI don't seem to get description text when hovering over the properties and
methods that my control exposes. I use Description[("description txt")] attribute. The description is however showing when viewing Properties and Events in the DevStudio's "Properties" tab. Any way to get the description to snow in code when typing as well? Thanks You're going to need to use XML comments. Add the appropriate XML comments
to all the methods/properties/events/etc. You should see an option to set the "XML Documentation File" through the "Configuration Properties - > Build" section of the property page for the project (C#). This output file should be named the same as your assembly, but with the xml extension. Place this xml file in the same directory with your assembly. XML documentation is only supported out of the box, for VS.Net 2003, in C# (http://msdn.microsoft.com/library/default.asp?url=/library/en-us/csref/html /vcoriXMLDocumentation.asp). But if you're using VB.Net I think that there is an add-on to allow XML comments. -- Show quoteTim Wilson ..Net Compact Framework MVP "Serg" <S***@discussions.microsoft.com> wrote in message news:1BC2C561-A399-417B-9480-5EB2E09EE514@microsoft.com... > I don't seem to get description text when hovering over the properties and > methods that my control exposes. I use Description[("description txt")] > attribute. The description is however showing when viewing Properties and > Events in the DevStudio's "Properties" tab. > > Any way to get the description to snow in code when typing as well? > > Thanks Got it, thanks a lot!
Show quote "Tim Wilson" wrote: > You're going to need to use XML comments. Add the appropriate XML comments > to all the methods/properties/events/etc. You should see an option to set > the "XML Documentation File" through the "Configuration Properties - > > Build" section of the property page for the project (C#). This output file > should be named the same as your assembly, but with the xml extension. Place > this xml file in the same directory with your assembly. XML documentation is > only supported out of the box, for VS.Net 2003, in C# > (http://msdn.microsoft.com/library/default.asp?url=/library/en-us/csref/html > /vcoriXMLDocumentation.asp). But if you're using VB.Net I think that there > is an add-on to allow XML comments. > > -- > Tim Wilson > ..Net Compact Framework MVP > > "Serg" <S***@discussions.microsoft.com> wrote in message > news:1BC2C561-A399-417B-9480-5EB2E09EE514@microsoft.com... > > I don't seem to get description text when hovering over the properties and > > methods that my control exposes. I use Description[("description txt")] > > attribute. The description is however showing when viewing Properties and > > Events in the DevStudio's "Properties" tab. > > > > Any way to get the description to snow in code when typing as well? > > > > Thanks > > > "Serg" <S***@discussions.microsoft.com> schrieb: Adding IntelliSense tooltips, XML comments, and documentation>I don't seem to get description text when hovering over the properties and > methods that my control exposes. I use Description[("description txt")] > attribute. The description is however showing when viewing Properties and > Events in the DevStudio's "Properties" tab. <URL:http://dotnet.mvps.org/dotnet/faqs/?id=tooltipsxmldocumentation&lang=en> -- M S Herfried K. Wagner M V P <URL:http://dotnet.mvps.org/> V B <URL:http://dotnet.mvps.org/dotnet/faqs/> |
|||||||||||||||||||||||