Intellisence

  • Thread starter Thread starter patrickparent
  • Start date Start date
P

patrickparent

I have search this forum and I want to know if there is only the XML
way to add function description to Intellisence, or there is any way to
do it like this

<Description("Description etc...")> Public Sub Qwerty

Patrick
 
You can create IntelliSense info only with XML file. <Description>
attribute is used for other purpose - Properties window. When you select
any property of control or component in Properties Window, you can see
short description. This description is not extracted from your comments
but from Description attribute. See http://tinyurl.com/rvrpf for
screenshots of all kinds of documentation you can provide for your code.
 
type in 3 comment characters in a row....then youl get an XML template to add
descriptions for the method, returning value, and parameters
 
type in 3 comment characters in a row....then youl get an XML template to add
descriptions for the method, returning value, and parameters
Click to expand...

Yes, but this is only half of the story. Info from XML comments is not
compiled into assembly. You need to generate XML file and distribute it
with your DLL.

On the other hand, info from <Description> attribute is compiled into
assembly so you don't need anything else. But as I said, it is only used
in Properties window, not in Intellisense.

To sum it up, you cannot have IntelliSense only with pure DLL file
without additional XML file.
 
Back
Top