Member-only story
Documenting Code
Documentation an essay on the importance of documentation.
the usually printed instructions, comments, and information for using a particular piece or system of computer software or hardware
Documentation allergy.
What is documentation allergy ? It is nothing more or less than the adverse reaction developers have to annotating their code with pieces of text so that the next developer might understand the piece of code they are staring at. Now we must realize this isn't malicious intent, the most used argument is Good code documents itself. And that brings us to the second part of this article.
Good code documents itself.
No matter what programming language is being used, they all have conventions and more often than not those will align with one another. Naming of functions, variables, proper declaration and type casting etc etc etc. This has given us a false sense of security in that we now imagine that because our function name is descriptive and the variables are named correctly, that is all the next developer needs to see in order to completely comprehend what is happening.
Sometimes, this is true. Often it's not. Things change, better solutions are thought off, and other conventions take place over the old. Some remain others do not. But there is a…
