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

comment on

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

Find out who wrote the code and be nice to them. Offer to buy them lunch. Pick their brains. Learn all about them. Were they accomplished programmers or newbies when they wrote the system? Are they careful or slapdash? Are they domain experts? What was the political climate when they wrote the system? No matter how well documented a system, there is always extra important information and ideas available only inside the original designer's head.

As you understand a section of code, comment it. If you see something that looks dubious, mark it with XXX, say. You can come back to these XXXs when you better understand the system as a whole and have more time.

Whenever you find a bug in the system, write a test for it. Grow the test suite over time. I assume (like me) you will not be given time to write a comprehensive test suite before taking over maintenance of the code base.

See also Analyzing large Perl code base. and the book Perl Medic by Peter Scott.

In reply to Re: Becoming familiar with a too-big codebase? by eyepopslikeamosquito
in thread Becoming familiar with a too-big codebase? by aboyd

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 making s'mores by the fire in the courtyard of the Monastery: (3)
    As of 2021-03-04 04:02 GMT
    Find Nodes?
      Voting Booth?
      My favorite kind of desktop background is:

      Results (98 votes). Check out past polls.