Last Updated: February 25, 2016
·
369
· somehume

A case for documentation when learning to code

Documentation can save a great deal of time when working with groups as it helps members to understand the logic of a program without needing to walk through it. It can also be very useful when learning to code or working with people who are learning to code.

Many of the students that I tutor often repeatedly ask the same questions over and over again. After instructing them to add documentation (comments) for what a specific block of code does, they tend to get lost in their code a lot less frequently.

As much as I like hopping straight into coding my solo projects, having some sort of breadcrumbs between late night coding sessions reduces the amount of time that I stare at the screen without being productive.

If you are just starting out with programming, learn how to create comments in your language of choice and try it out.

1 Response
Add your response

Couldn't agree more. Even for experienced developers having good documentation is a significant help when you come back to a project after leaving it for some time.

over 1 year ago ·