Re: Self-document code -> dependencies

If you did a call hierarchy on one of the constants, would a directed graph
of the methods that call that constant be what you're looking for? I have a
simple plug-in for Eclipse that translates the Call Hierarchy tree nodes to
GraphViz dot notation and then renders the image. Hacking the plug-in to
dump the raw dot wouldn't be too hard -- or possibly just writing a Ruby
script to parse the source code and output the dot notation may not be that
hard either.

On Tue, Feb 16, 2010 at 2:41 PM, Greg Akins <[email protected]> wrote:

>
>
> 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
>  
>



-- 
Chris


[Non-text portions of this message have been removed]



------------------------------------

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/