Next time someone wants to understand what happens inside your code, all you have to do is point them to the documentation. Taking that extra time to write a proper description of what you worked on will save huge amounts of time in the future.
When that day comes, you will not remember so vividly what you wrote and why.Īnd if you do remember, there may be some edge cases or specific uses which may not be clearly apparent. No matter what you are developing, chances are that some day you or one of your colleagues will have to revisit it. It is the least thought about detail that can make the most difference in the future. Documentation is pretty much left out of the equation. When developing a feature that needs to be completed within a certain time frame, rarely do we have a moment to stop everything and focus on documenting our code.Īpart from designing and writing the code itself, we also need to undergo code reviews, automation tests, and add unit tests (to name a few things). The main reason code goes undocumented is because of time. In this article, I’ll argue why documenting your code will lead to becoming a better developer, and will contribute to being a great team member.
But, when it comes to documenting or commenting your code, there is no simple catchphrase.ĭocumentation should be as important to a developer as all other facets of development KISS, DRY, SOLID… and so on and so forth.
Denfine jef raskin software#
There are a plethora of acronyms when it comes to software development.
0 kommentar(er)
