Bad documentation insanity of the day

[Chris Borokowski]

When Andy G opened up libsymblogy.h (sic), he was relieved. Finally,
some documentation! Of course, upon further inspection, Andy realized
that the comments didn’t quite explain how the code works, how it
interfaces with other modules, or even why it uses certain magic
numbers like -13. Instead, every function had a comment just as
hyperverbose and vapid as this...

http://worsethanfailure.com/Articles/Hyperverbosity-.aspx

Read on for the horror... the horror...


http://technical-writing.dionysius.com/
technical writing | consulting | development


      ____________________________________________________________________________________
Never miss a thing.  Make Yahoo your home page. 
http://www.yahoo.com/r/hs