Tools To Tackle New Code Base?  
Author Message
Gerry Murphy





PostPosted: 2004-5-26 20:28:00 Top

java-programmer, Tools To Tackle New Code Base? Hi,

I'm looking for advice on how to quickly come to grips with
a large ( ~5000 files), undocumented codebase that's mostly Java
( compiles with Sun's command line compiler under Windows XP ).

Here are some considerations.

1) I'm new to Java, coming from a C++ background
2) I need to get a handle on this quickly but also cheaply.
3) I have no access to the original programmer.

What tools are availble that might help me analyze and
visualize the relationship between various modules and classes
in this project? In the past, with large C++ codebases I've
looked at Doxygen but the learning curve seemed very steep
and I never did figure out the graphical tools.

Appreciate any advice, the more concrete the better.
If there's a different forum I should be posting this in please let
me know.

TIA,

Gerry Murphy


 
Andrew Thompson





PostPosted: 2004-5-26 20:45:00 Top

java-programmer >> Tools To Tackle New Code Base? On Wed, 26 May 2004 08:27:46 -0400, Gerry Murphy wrote:

> I'm looking for advice on how to quickly come to grips with
> a large ( ~5000 files), undocumented codebase that's mostly Java
> ( compiles with Sun's command line compiler under Windows XP ).

Do you know of Sun's JavaDoc tool?
<http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html>

If the .java source has the comments defined,
it can be invaluable as a quick reference to
the classes and methods of an API..

Even if the comments are not defined,
the JavaDocs will still give an idea
of inheritence/use etc.

--
Andrew Thompson
http://www.PhySci.org/ Open-source software suite
http://www.PhySci.org/codes/ Web & IT Help
http://www.1point1C.org/ Science & Technology
 
Roedy Green





PostPosted: 2004-5-27 3:14:00 Top

java-programmer >> Tools To Tackle New Code Base? On Wed, 26 May 2004 12:45:22 GMT, Andrew Thompson
<email***@***.com> wrote or quoted :

>Even if the comments are not defined,
>the JavaDocs will still give an idea
>of inheritence/use etc.

The biggie, which I just learned about, is the, "USE" button that
tells you other classes that use such a beast or produce such a beast.

--
Canadian Mind Products, Roedy Green.
Coaching, problem solving, economical contract programming.
See http://mindprod.com/jgloss/jgloss.html for The Java Glossary.
 
 
Roedy Green





PostPosted: 2004-5-27 3:15:00 Top

java-programmer >> Tools To Tackle New Code Base? On Wed, 26 May 2004 08:27:46 -0400, "Gerry Murphy"
<email***@***.com> wrote or quoted :

> I'm looking for advice on how to quickly come to grips with
>a large ( ~5000 files), undocumented codebase that's mostly Java
>( compiles with Sun's command line compiler under Windows XP ).

Try http://mindprod.com/jgloss/juliet.html
for clever navigation.

--
Canadian Mind Products, Roedy Green.
Coaching, problem solving, economical contract programming.
See http://mindprod.com/jgloss/jgloss.html for The Java Glossary.
 
 
Andrew Thompson





PostPosted: 2004-5-27 3:21:00 Top

java-programmer >> Tools To Tackle New Code Base? On Wed, 26 May 2004 19:14:21 GMT, Roedy Green wrote:

> On Wed, 26 May 2004 12:45:22 GMT, Andrew Thompson
> <email***@***.com> wrote or quoted :
>
>>Even if the comments are not defined,
>>the JavaDocs will still give an idea
>>of inheritence/use etc.
>
> The biggie, which I just learned about, is the, "USE" button that
> tells you other classes that use such a beast or produce such a beast.

Oh yes, most handy..

Mind you, once you start throwing on all
those JDoc options, expect the size of
the docs to balloon considerably..

[ But s**t hey. I don't mind - it's worth it! ]

--
Andrew Thompson
http://www.PhySci.org/ Open-source software suite
http://www.PhySci.org/codes/ Web & IT Help
http://www.1point1C.org/ Science & Technology
 
 
Gerry Murphy





PostPosted: 2004-5-27 4:12:00 Top

java-programmer >> Tools To Tackle New Code Base? Hi,

Thanks for responding.

That's at the top my list of tools to look at..
Has it got any graphical tools that let you visualize
the directory structure or module relationships of
a project? ( Or should I even be asking this?)

Thanks again for your response.


Regards,

Gerry Murphy
"Andrew Thompson" <email***@***.com> wrote in message
news:20cgz6jt6im8.z5bnn8hsw8kh$email***@***.com...
> On Wed, 26 May 2004 08:27:46 -0400, Gerry Murphy wrote:
>
> > I'm looking for advice on how to quickly come to grips with
> > a large ( ~5000 files), undocumented codebase that's mostly Java
> > ( compiles with Sun's command line compiler under Windows XP ).
>
> Do you know of Sun's JavaDoc tool?
> <http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html>
>
> If the .java source has the comments defined,
> it can be invaluable as a quick reference to
> the classes and methods of an API..
>
> Even if the comments are not defined,
> the JavaDocs will still give an idea
> of inheritence/use etc.
>
> --
> Andrew Thompson
> http://www.PhySci.org/ Open-source software suite
> http://www.PhySci.org/codes/ Web & IT Help
> http://www.1point1C.org/ Science & Technology


 
 
Andrew Thompson





PostPosted: 2004-5-27 4:24:00 Top

java-programmer >> Tools To Tackle New Code Base? On Wed, 26 May 2004 16:12:29 -0400, Gerry Murphy wrote:

> Thanks for responding.

Do you C++ programmers think upside down?
<http://www.physci.org/codes/javafaq.jsp#netiquette>

> That's at the top my list of tools to look at..
> Has it got any graphical tools

Graphical, as in browser? :)

>..that let you visualize
> the directory structure or module relationships of
> a project?

(shrugs vaguely) Does a nested list of
class relationships that is hyperlinked
fit that description?

>..( Or should I even be asking this?)

You should be invoking the JavaDoc tool and
examining the output. ;-)

--
Andrew Thompson
http://www.PhySci.org/ Open-source software suite
http://www.PhySci.org/codes/ Web & IT Help
http://www.1point1C.org/ Science & Technology
 
 
Gerry Murphy





PostPosted: 2004-5-31 0:40:00 Top

java-programmer >> Tools To Tackle New Code Base? I was just asking for advice, not a snooty attitude
and gratuitous insults.

BTW: Graphical as in 'graphical'. Look it up.


"Andrew Thompson" <email***@***.com> wrote in message
news:1myxlpzximf1i.m7hka10jwdd8$email***@***.com...
> On Wed, 26 May 2004 16:12:29 -0400, Gerry Murphy wrote:
>
> > Thanks for responding.
>
> Do you C++ programmers think upside down?
> <http://www.physci.org/codes/javafaq.jsp#netiquette>
>
> > That's at the top my list of tools to look at..
> > Has it got any graphical tools
>
> Graphical, as in browser? :)
>
> >..that let you visualize
> > the directory structure or module relationships of
> > a project?
>
> (shrugs vaguely) Does a nested list of
> class relationships that is hyperlinked
> fit that description?
>
> >..( Or should I even be asking this?)
>
> You should be invoking the JavaDoc tool and
> examining the output. ;-)
>
> --
> Andrew Thompson
> http://www.PhySci.org/ Open-source software suite
> http://www.PhySci.org/codes/ Web & IT Help
> http://www.1point1C.org/ Science & Technology


 
 
Joe





PostPosted: 2004-5-31 3:31:00 Top

java-programmer >> Tools To Tackle New Code Base? In article <40ba0e3d$0$3113$email***@***.com>, email***@***.com
says...
> I was just asking for advice, not a snooty attitude
> and gratuitous insults.
>
> BTW: Graphical as in 'graphical'. Look it up.


The quality of responses will vary depending on the audience you
alienate. When you top-post, people who are most likely to give
thoughtful and considerate answers will skip your post instead of trying
to decipher the thread. That leaves the readers who live to flame. Your
choice.
 
 
Ryan Stewart





PostPosted: 2004-5-31 6:39:00 Top

java-programmer >> Tools To Tackle New Code Base? "Gerry Murphy" <email***@***.com> wrote in message
news:40ba0e3d$0$3113$email***@***.com...
*fixed top post*
> "Andrew Thompson" <email***@***.com> wrote in message
> news:1myxlpzximf1i.m7hka10jwdd8$email***@***.com...
> > On Wed, 26 May 2004 16:12:29 -0400, Gerry Murphy wrote:
> > > That's at the top my list of tools to look at..
> > > Has it got any graphical tools
> >
> > Graphical, as in browser? :)
> >
> > >..that let you visualize
> > > the directory structure or module relationships of
> > > a project?
> >
> > (shrugs vaguely) Does a nested list of
> > class relationships that is hyperlinked
> > fit that description?
> >
> > >..( Or should I even be asking this?)
> >
> > You should be invoking the JavaDoc tool and
> > examining the output. ;-)
> >
> I was just asking for advice, not a snooty attitude
> and gratuitous insults.
>
> BTW: Graphical as in 'graphical'. Look it up.
>

1.
a. Of or relating to written representation.
b. Of or relating to pictorial representation.
2. Of, relating to, or represented by or as if by a graph.
3.
a. Described in vivid detail.
b. Clearly outlined or set forth.
4. Of or relating to the graphic arts.
5. Of or relating to graphics.
6. Geology. Having crystals resembling printed characters.

I doubt you're looking for 2 or 6. Since a browser is typically part of a
Graphical User Interface, I'd say it fits most people's ideas of graphical.
Instead of assuming he's insulting you, why don't you check out JavaDoc and
see if it's what you want?


 
 
Ira Baxter





PostPosted: 2004-6-3 4:29:00 Top

java-programmer >> Tools To Tackle New Code Base?
"Gerry Murphy" <email***@***.com> wrote in message
news:40b48d1c$0$3158$email***@***.com...
>
> I'm looking for advice on how to quickly come to grips with
> a large ( ~5000 files), undocumented codebase that's mostly Java
> ( compiles with Sun's command line compiler under Windows XP ).
>

You might consider the Java Source Code Browser =
JavaDoc + Full Hyperlinked source text tying the JavaDoc
info to sources and providing a full cross reference of
symbol definitions and uses.

See http://www.semdesigns.com/Products/Formatters/JavaBrowser.html

--
Ira D. Baxter, Ph.D., CTO 512-250-1018
Semantic Designs, Inc. www.semdesigns.com




----== Posted via Newsfeed.Com - Unlimited-Uncensored-Secure Usenet News==----
http://www.newsfeed.com The #1 Newsgroup Service in the World! >100,000 Newsgroups
---= 19 East/West-Coast Specialized Servers - Total Privacy via Encryption =---