Slashdot Mirror


Documentation As a Bug-Finding Tool

New submitter Sekrimo writes "This article discusses an interesting advantage to writing documentation. While the author acknowledges that developers often write documentation so that others may better understand their code, he claims documenting can also be a useful way to find bugs before they ever become an issue. Taking the time to write this documentation helps to ensure that you've thought through every aspect of your program fully, and cleared up any issues that may arise."

2 of 188 comments (clear)

  1. Re:Common knowledge? by Anonymous Coward · · Score: 2, Funny

    Kudos to you if you can refactor the implementation in your head before you write it!

  2. Re:Theory doesn't always work in practice. by ThirdPrize · · Score: 5, Funny

    Wrong. First you write the documentation, then you write the tests and then, if you have time, you write the code.

    --
    I have excellent Karma and I am not afraid to Troll it.