Self-Documenting Code: The Approach

Beginning programmers are taught during their coursework to get into good programming habits. One of them is to do everything in your power to have what is called "Self-Documenting Code." Some things that can be helpful are to remember:

Comment Everything. Begin every section with comments that begin with commenting slashes "//" at the beginning of every module or the end of each module significant ending point of functions and modules. For multiple line comments you want to begin and end with "/*" and "*/". Each programming language will have its own syntax rules about what character you use prior to inserting comments into the code.

Consistently choose meaningful variable names. For example, name a color variable "colorBlue" and not something like "color1" etc... The first choice reads better and tells other programmers what the variable means and what its purpose is.

Keep naming conventions consistent. Decide what naming conventions you will use and stick to it throughout the entire program. For example, name your variables using all lowercase then uppercase with each additional word or start all variables with uppercase. Sometimes the languages you choose will determine the casing rules for you.

No matter what kind of project you work on, keep in mind if stay consistent on your comment practices, variable and naming conventions it will keep your code as self-documenting as possible. It will also be easier to read and to maintain over the long haul.