Beefy Boxes and Bandwidth Generously Provided by pair Networks
P is for Practical

comment on

( #3333=superdoc: print w/replies, xml ) Need Help??

I can come up with many reasons why you want to put time and effort into this!

For the purpose of the this discussion, let us assume I have taken over the module the OP wrote years ago, and for good reason, he/she put up for grabs (no more interest in Perl, no more access to required resources, left life, ...).

Now, for obvious reasons, I do *not* like the style/layout of the code this module was (consistently) written in, and - also for this discussion - the module has thousands of lines of code.

I think that code needs to be easy to *read* in order to be able to maintain it properly, so next to *consistent* indentation and styling, it needs to be beautiful and that is where perltidy drops in place.

Whatever style the module's code was written in, I run perltidy with *my* preferences, and suddenly all the code looks beautiful, so I can understand it. Next step is to edit all the code by hand and make the last mis-formats match my own style. As no software is perfect, there will be parts that are not formatted according taste.

By browsing/editing the codebase, I now get acquainted by the code's structure and main parts and I can start focusing on open issues and bugs.

By having a .perltidyrc file that formats the code to as close as possible what you think is best (and we will not agree there), you will save yourself a lot of time later on.

Enjoy, Have FUN! H.Merijn

In reply to Re^2: Why is perltidy using indent-columns instead of continuation-indentation when breaking up a long if-line? by Tux
in thread Why is perltidy using indent-columns instead of continuation-indentation when breaking up a long if-line? by torgny

Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":

  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.
  • Log In?

    What's my password?
    Create A New User
    and the web crawler heard nothing...

    How do I use this? | Other CB clients
    Other Users?
    Others contemplating the Monastery: (3)
    As of 2020-08-14 23:24 GMT
    Find Nodes?
      Voting Booth?
      Which rocket would you take to Mars?

      Results (76 votes). Check out past polls.