Beefy Boxes and Bandwidth Generously Provided by pair Networks
Keep It Simple, Stupid

Re: best practice

by fokat (Deacon)
on Aug 27, 2001 at 21:52 UTC ( #108188=note: print w/replies, xml ) Need Help??

in reply to best practice

In my experience, I generally follow these steps when approaching a "programming challenge":
  • Think about the problem. Try to look at the problem carefully from distinct angles. I always try to reduce the problem or to divide it into sub-problems. Many of those can probably become modules (that you write, or that you get from CPAN).

    Look for ways to make your approach as general as possible, so that the tool that you're writing will remain useful for as long as possible.

    Do not try to implement all the bells and whistles in the first pass. Stick to the basics and get a prototype running, then add features slowly. Test at each step.

  • Document before writing code. If you have a set of nice sub-problems to work at, focus on them one at a time. Chances are you can solve them easily with one or more modules.

    If this is the path you decided to follow, think a bit about the naming of the module, so that it reflects its function. Always start with h2ph. The very first thing to do after that, is to force yourself to write documentation for the module.

    Writing the documentation first sets very clearly your design and functionality goal. (After all, if you code first and it works, you know you'll never write the docs anyway). This also gives you a chance to design what the interface of the module will look like.

    If the docs you produce are detailed enough, you can spot problems before your test cases do, and plan on them ahead of time.

  • Code the modules AND the test cases Do both at once. Test cases must cover your code and insure that it is portable (yeah, I know this thingy you're writing only needs to be used this time...).

    Your code must be clean and easy to read. Add comments where decisions are taken in your code. Always use strict and -w. They're your friends.

I wish you luck and wisdom.

Log In?

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

How do I use this? | Other CB clients
Other Users?
Others chanting in the Monastery: (1)
As of 2020-10-25 12:52 GMT
Find Nodes?
    Voting Booth?
    My favourite web site is:

    Results (249 votes). Check out past polls.