Beefy Boxes and Bandwidth Generously Provided by pair Networks
There's more than one way to do things
 
PerlMonks  

Re: On maintaining old code and the battle of styles...

by andreychek (Parson)
on Apr 25, 2002 at 15:04 UTC ( #161982=note: print w/ replies, xml ) Need Help??


in reply to On maintaining old code and the battle of styles...

I think a good way that this is often dealt with is for the original author to create a written style guide for their particular application, and for each author afterwards to follow that guide. Unfortunatly, since that isn't defined by the original author, you're going to have to be the responsible one to take care of that :-)

It may be hard enough for you to go through someone elses code, and learn enough about their styles and preferences to figure out what they are trying to do with their code. However, as you're suggesting -- if you change styles for code that you add, it's going to become very tough for anyone to read it (possibly including yourself after a few weeks of maintenance), without getting a headache :-)

I love documentation. Perhaps what you can do is create a document, explaining the currently used style. Then, if there is an area where you feel a style could be improved (and it sounds like there's plenty of them), change both the code, and the documented style guide, at the same time. Yes, that can be a big deal, but it's probably going to be much easier to do that, than to maintain two seperate styles :-)

I'm very fond of the Style Guide for P5EE, you could always use something like that as a basis.

Good luck!
-Eric


Comment on Re: On maintaining old code and the battle of styles...

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://161982]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others pondering the Monastery: (5)
As of 2014-10-25 23:36 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    For retirement, I am banking on:










    Results (149 votes), past polls