Self-document code -> dependencies
Greg Akins <[email protected]> Tue, 16 Feb 2010 15:41:21 -0500
| Newsgroups | gmane.comp.programming.refactoring |
|---|---|
| Message-ID | <[email protected]> |
I've been asked to document some legacy code to illustrate the Usages
of some Constant values. I feel like there should be a way to either
generate the documentation directly from the code or make the code
more self-documenting. Does anyone have any suggestions?
Basically the constants represent Strings which are passed to a
mainframe to call specific transactions.
Those Consts are referenced in some methods in an internal library,
then that library is consumed by the application.
My document looks like a graph of the relationship of those consts -> methods
First, I thought I could use a Dependency graph to do this for me
(Tried DependencyFinder & Structure 101) but neither of them handled
the straight method to method mapping ; they mostly focused on class
-> class)
The application is in Java 1.4
Thanks
--
Greg Akins
http://insomnia-consulting.org
http://www.pghcodingdojo.org
http://pittjug.dev.java.net
------------------------------------
Yahoo! Groups Links
<*> To visit your group on the web, go to:
http://groups.yahoo.com/group/refactoring/
<*> Your email settings:
Individual Email | Traditional
<*> To change settings online go to:
http://groups.yahoo.com/group/refactoring/join
(Yahoo! ID required)
<*> To change settings via email:
[email protected]
[email protected]
<*> To unsubscribe from this group, send an email to:
[email protected]
<*> Your use of Yahoo! Groups is subject to:
http://docs.yahoo.com/info/terms/