anotheranne has asked for the wisdom of the Perl Monks concerning the following question:

Hi,

Is there such a beast?

I have just started to use perltidy and perlcritic which are great helps. So is there a similar informational module that will print out an outline of a project directory with file structure along with main contents (use statements. subroutine names etc)?

Short of a large chart on the wall how can I more easily keep track of programme development?

I have looked on cpan but this is trying to find a needle in a haystack, I obviously am not searching for the right thing.

Anne

Replies are listed 'Best First'.
Re: wanted: project outline module
by FunkyMonk (Bishop) on Jun 06, 2011 at 21:06 UTC
Re: wanted: project outline module
by JavaFan (Canon) on Jun 06, 2011 at 20:34 UTC
    I presume you want something else than h2xs is giving you?
Re: wanted: project outline module
by Boldra (Curate) on Jun 07, 2011 at 08:52 UTC
Re: wanted: project outline module
by anotheranne (Initiate) on Jun 07, 2011 at 18:40 UTC

    Hi, & thanks for the input.

    All you guys are way ahead of me as I'm only looking for something simple just to keep track of what I am doing (actually following the examples in the Catalyst book).

    The UML is something I should investigate. I had used 'Dia' before to make a better hardcopy of things than I can with a whiteboard marker. This time I found a utility 'autodia' which produces a diagram from my top level working directory to view in Dia. But the output is not all I need.

    Eclipse/Epic looks good but I'm using vim & not ready for an editor change. In the absence of something as simple in concept as perltidy I might just get a bigger whiteboard - that's about all my current state of perl will support.

    Anne
Re: wanted: project outline module
by armstd (Friar) on Jun 07, 2011 at 14:55 UTC

    Eclipse/EPIC can provide some of that during development, but I believe its only for the current file with the Outline view. I don't think you can get a project Outline, which is a shame. I think Komodo can do a project outline with its code browser, but I don't use Komodo myself, so not much help there.

    http://www.epic-ide.org/

    Any project of sufficient size probably deserves a UML model though. A class diagram is my personal favorite UML diagram, and it provides exactly the information you're looking for, plus some, such as class attributes. Class diagrams really are the kind of big chart you want printed on your whiteboard or wall, so you can really think about what you're doing and where you're going.

    Some UML editors will generate code stubs for you as you model. Eclipse has good modeling functionality, but it won't generate Perl code last I checked. It will automatically generate diagrams from the model though. It's a lot of work, but well worth it.

    IMO, Perl is a language that lends itself to automatic code generation at runtime, but not so much during development time. :)

    --Dave

Re: wanted: project outline module
by bduggan (Pilgrim) on Jun 08, 2011 at 15:44 UTC
      definitely a must, thanks for that. Anne
Re: wanted: project outline module
by thargas (Deacon) on Jun 08, 2011 at 11:28 UTC
    If you're wanting to get into UML retroactively, the module UML::Class::Simple will allow you to generate a UML class diagram from your code. It's not perfect, but it can be helpful.
      cool! Anne