Wednesday, August 24, 2005
Great Advice
From Sarah Satterthwaite on the Oracle-l mailing list
When documenting your code, be sure to also document your doubts about how
you did it. I find that most of the bugs that are found in my code are
things I wasn't very confident about at the time!
2 Comments
When documenting your code, be sure to also document your doubts about how
you did it. I find that most of the bugs that are found in my code are
things I wasn't very confident about at the time!
2 Comments:
I totally agree.
Think about it: if someone is reading your code, they must have a good reason. Fixing an error has to be the most common reason someone would be reading your code.
When I document my code, I try to anticipate the needs to whoever is reading it. That includes highlighting things that were implemented in a less-than-ideal way and that may cause problems.
Post a Comment
Think about it: if someone is reading your code, they must have a good reason. Fixing an error has to be the most common reason someone would be reading your code.
When I document my code, I try to anticipate the needs to whoever is reading it. That includes highlighting things that were implemented in a less-than-ideal way and that may cause problems.
