LWN.net Logo

Quotes of the week - all about documentation

Quotes of the week - all about documentation

Posted Dec 11, 2008 22:22 UTC (Thu) by marduk (subscriber, #3831)
In reply to: Quotes of the week - all about documentation by stijn
Parent article: Quotes of the week - all about documentation

That works until you write something and then immediately get put on another project or part of the code, then someone else gets your code and makes more undocumented changes and again and again. Eventually your code comes back your way and you're like... wtf?


(Log in to post comments)

Quotes of the week - all about documentation

Posted Dec 12, 2008 10:25 UTC (Fri) by stijn (subscriber, #570) [Link]

It was merely an observation. Additionally, your scenario was already included in my description. If I am the second developer getting the first developer's code, I would definitely add comments as I went in. So, I am advocating this as a good habit to follow at a personal level rather than as project documentation guidelines.

Copyright © 2013, Eklektix, Inc.
Comments and public postings are copyrighted by their creators.
Linux is a registered trademark of Linus Torvalds