Property Description

  • Thread starter Thread starter David Nash
  • Start date Start date
D

David Nash

I am writing a very large class with 150+ properties. The number of
properties and overrides is making the class hard to understand for other
developers. I would like to be able to give a description of what
information each property is returning. I have seen many times where a
short message is given in the tool tip text when coding in the IDE. Is
there any way to do this in my custom class?

Thanks,

David Nash
The GSI Group, Inc.
 
David,
I am writing a very large class with 150+ properties. The number of
properties and overrides is making the class hard to understand for other
developers.
Click to expand...
Sounds like you need to reconsider your design and split the single large
class into smaller more easily understood classes. Which in itself may make
it harder to understand for others...

I have seen many times where a short message is given in the tool tip text
when coding in the IDE. Is there any way to do this in my custom class?
Click to expand...
Are you using C# or VB.NET?

With C# look up XML Documentation in the on-line help.

With VB.NET there's the older, not as nice "XML Documentation Tool" at
http://www.gotdotnet.com/team/vb/

Then there's the newer, nicer "VB Commenter" at
http://www.gotdotnet.com/team/ide/, its nicer in that its an Add-In to
VS.NET that works as you type & compile the source.

There are a couple of others, only I do not have links handy. Searching
http://groups.google.com/groups?hl=en&lr=&ie=UTF-8&group=microsoft.public.dotnet
may turn up something.

NOTE: the above VB tools only work for compiled assemblies. With VS.NET 2005
(aka Whidbey, due out later in 2005) XML Documentation support will be
available for VB.NET.

Hope this helps
Jay
 
Back
Top