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
-
Nevoic1997yCode should be self documenting, if it's not then you need to refactor it.
Externally (an API page, GitHub, wiki pages, etc.) documentation is great (especially if people don't have access to source code).
Important distinction there. -
I love having it, well written documentation is like the Holy Grail to me. I've been trying to get better at writing my documents, or at least making better comments in my code. New rule for me is that at the beginning of each coding session I go back through what I wrote the previous day. I am not allowed to write any new code until the old code is documented. This way I never have more than 2-3 functions without comments/documentation.
-
I document whenever management makes me code something in a way that does not make sense for the user. I then write unit and ui tests around it. They can own the mess.
Related Rants
How many of you hate documentation and how many of you never skip it?
rant
documentation
zzz's