Documenting .NET Class Usage

  • Thread starter Thread starter Guest
  • Start date Start date
G

Guest

We have a number of fore 'Helper' classes that are used throughout our
application.

All code for the application is in VB.NET.

I have been asked to produce some documentation which will list usage for
particular methods in these 'Helper' classes so that out BA's can assess the
impact of any changes to these classes and hence modify their test plans
accordingly.

This documentation is aimed at our BA's\PM's that don't have VS.NET
installed. Likely destination for the results are either a compiled help file
or intranet or both.

Where on earth do I start?

Thanks!
 
Thanks Umer, we already use Document!X to produce MSDN style class
documentation.

What I was looking for is something that would help me answer the following
sort of question...

"Where do methods from class 'abcHelper' get used?"

It is an impact type question as in, if we modify a particular method then
what is the likely knock on effect and from that work out which test plans
should be used ( and perhaps which ones need modifying).

Thanks!
 
Hi George,

There is a Procedure Callers feature in my add-in (below). It shows the code
that calls a given procedure in a treview (project, file, class, etc). The
results can be exported to clipboard or text files.

--
Best regards,

Carlos J. Quintero

MZ-Tools: Productivity add-ins for Visual Studio .NET, VB6, VB5 and VBA
You can code, design and document much faster.
Free resources for add-in developers:
http://www.mztools.com
 
Back
Top