Beefy Boxes and Bandwidth Generously Provided by pair Networks
Just another Perl shrine
 
PerlMonks  

comment on

( [id://3333]=superdoc: print w/replies, xml ) Need Help??

One way to make code refactoring more palatable to the original authors is to add a lot of useful comments as you 'get to know the code'. I have rarely found existing code to be adequately POD-ed and you could make substantial changes to code under the guise of 'just cleaning up a little while I comment'.

Another technique I have used is to apply an OO veneer over non-modular code, changing the things I don't like while talking about it as though it was 'just a minor refactor'.

Most developers accept that they could have written their former code better, but there is no need to rub their faces in it. A little politeness never hurt anyone, especially where there are so many different (and sometimes equally valid) ways to solve a problem.

Fundamentally, though, you are either responsible for the code or you aren't. If you are, then (in my view) you can do whatever you think best, and there is no need to 'present' your changes to the original authors (who probably don't care and are working on something else). Personally, I would just keep quiet about it, write good documentation that justifies any extensive changes, and treat your predecessors with deference and grace. Above all, don't change anything unless you fully understand and can test it, and don't be afraid to ask for help.


No good deed goes unpunished. -- (attributed to) Oscar Wilde

In reply to Re: Consideration for others code by ptum
in thread Consideration for others code by tcf03

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



  • Are you posting in the right place? Check out Where do I post X? to know for sure.
  • Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
    <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
  • Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
  • Want more info? How to link or How to display code and escape characters are good places to start.
Log In?
Username:
Password:

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

How do I use this?Last hourOther CB clients
Other Users?
Others lurking in the Monastery: (4)
As of 2024-03-29 00:42 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found