Learning to Program

Documentation

Documentation is so important that it is the subject of the next chapter. Throughout this book, you have seen one form of documentation in the form of comments. Documentation is crucial to you being confident in your code. If you don’t document your code as you go, you might forget what your code is supposed to do. Although code is meant for humans to understand, that doesn’t mean it reads like a novel. In theory, you can read through it all to get an idea of what is going on, but that can take a long time—and you still might not remember why you made certain decisions. If you document your decisions as you make them, you can have more confidence that you made the right decision. Documentation involves a lot more, too, as you will ...