Ranter
Join devRant
Do all the things like
++ or -- rants, post your own rants, comment on others' rants and build your customized dev avatar
Sign Up
Pipeless API
From the creators of devRant, Pipeless lets you power real-time personalized recommendations and activity feeds using a simple API
Learn More
Comments
-
But my code is so clean and readable that you don't need any documentation to understand it.
-
@neewbie said many devs fooling themselves into not writing comments, only to come back to the code 12 months later and want to punch themselves in the face.
-
rasmus1028yI would say that documentation is the golden rule. In first aspect, we have the client who pays for a dev project and if you are able to show the client what is done that's really good (customer focus!!) and for the other aspect, think about how you feel by your self sitting behind the screen and keyboard trying to understand the chain of functions in the code or trying to find the specific part of the software but it is not there.
Well, with that said - always document your own work. For the last aspect, when you get back to the code of a 6 month old project, maybe you will think "what the h*ll did I do here, why did I not document it...?"
Pro tip: preserve your job by not documenting it.
undefined