Skip to main content

When Do I Refactor?

When do I know it's time to refactor code?


Refactoring is different for every person but for me I follow these guidelines:
- If I don't know / understand the code, I don't refactor.  Period!
- Is the code broken?  If not then I generally don't refactor
- Can the code be made much simpler?  If the amount of code can be reduced by 2x and made cleaner / simpler then I may refactor.
- Can the existing code handle the new feature / bug fix?  If not then I may refactor.
- I will not refactor the code if I think I have a better way.  Better my be for me but not other developers.  I leave working code working.

Tests:
I never assume that tests for existing code:
-  Has complete code coverage (I've never seen this yet).  I've seen 100% coverage but not all combinations of logic or possible side effects of API changes, etc.
- That the tests are even correct.  The tests only test what the developer wanted to test, not what could / should happen.  Tests are never free from bugs just like the code that is being tested.  If there are x% of bugs for every 1,000 lines of code then the tests will also contain basically the same rate of bugs.

For these reasons, I never rely on tests for catch bugs when I refactoring code.  I need to fully understand the logic and intension of the code before I refactor.  Otherwise I'll just create additional bugs and duplicate failed logic in the new code.

For me, I try to make sure that my code is as solid, understandable and as simple as possible.  If code is not understandable then it's at rick of being churned by refactoring.

Comments

Post a Comment

Popular posts from this blog

Still Life

 Life is never still, at least I don't think you would want it to be.  That's why so many of us (i.e., retired care free people) travel.  Keep seeing new things and places.   Well the Hurricane so far inland was a new thing and one I would have rather forgone but life is what happens.  Life keeps moving. Except a still life is forever and captures a slice of time frozen in a painting.  This is from a wooden bowl of pears onboard our ship during dinner one nice.  Again, just thought it looked nice. Enjoy.
Post a Comment
Read more

A Trip Abroad

 Just back from our trip abroad as Asheville continues to recover from the hurricane.  This trip has been planned for a long time and we almost didn't make it because our dog sitting business will be closed for a while. But make it we did and now we are back. We love Amsterdam.  What a fun place to visit.  So many things to too and do there.  The weather was not the best but it did not have an impact on our visit.  Just bundle up. Got some quick painting in while on the boat (i.e., Viking) as we moved from port to port.  This painting is of a garden at a heritage site of windmills.  I thought it looked nice. Nice time on the trip to de-stress from what was happing back home.  We were fine back home but not everything is well with many others.
Post a Comment
Read more

A Process

Once in a while I take photos of a work in progress.  This is for me as well as others as the work moves from stage to stage.  And it is done in stages with defined processes for each step.  On this walkway overpass up in Spruce Pine, I've done both an ink / marker and an Ink / Wash on the same piece. This is the finished watercolor of the work.  To start the process I did an ink drawing of it and then took a tracing from that.  It's the tracing where I did another ink drawing but this time on watercolor paper. Tracings of a work is done with standard tracing paper.  I get mine from CheapJoes.com and use the 8x10 size as that covers most of my needs.  The tracing is done with a 0.3 ink pen (Winsor & Newton Fineliner).  Once I have the tracing I can then use it for other paper or to do another work of the same subject. The tracing is just a start as I still need to get it transferred onto other paper.  For that you need a very bright light...
Post a Comment
Read more