How to develop and debug your own code

A collection of noteworthy items selected by our moderators from discussions about making and using models with NEURON.

Moderators: wwlytton, tom_morse

Post Reply
ted
Site Admin
Posts: 5057
Joined: Wed May 18, 2005 4:50 pm
Location: Yale University School of Medicine
Contact:

How to develop and debug your own code

Post by ted » Wed Nov 08, 2006 10:36 am

Rule I: Don't write a bunch of code (or create a bunch of GUI windows) all at once, and then expect everything to work the first time you try it.
Algorithm for developing code that works:

Code: Select all

1. First, break the problem into a sequence of small tasks 
that can be implemented and tested, one at a time.
2. Pick the first task.
3. Write the code, or create the GUI tool, that accomplishes this task.
If this involves anything that you aren't absolutely sure about,
read the relevant entries in Programmer's Reference, 
and/or use the GUI on a toy problem to make sure you know what you're doing.
4. Repeat
     Test your program to see if it works.
     If it doesn't work, re-read the Programmer's Reference and revise the code
       (or work with the GUI tool)
   until your program works.
5. If no more tasks remain, your job is done.
Otherwise, pick the next task and go to step 3.
Rule II: Learn how to debug your own code.
Algorithm for debugging code:

Code: Select all

1. Try to break the code into chunks that accomplish 
a sequence of small tasks.
2. Comment out all of the code except for the little bit 
that accomplishes the first task.
3. Repeat
     Test the code to see if it works.
     If it doesn't work, re-read the Programmer's Reference, then revise the code.
   until the code works.
4. If no more chunks of code remain, your job is done.
Otherwise, uncomment the next chunk of code, and go to step 3.

Post Reply