Re:Reasons to avoid code comments
by TeMPOraL on Saturday July 13, 2013 @07:53AM
(#6037344)
> ...so you're saying, no one will read the documentation, because they'll all be looking at the documentation?
I think he means that devs won't be reading documentation like a book, chapter by chapter, trying to comprehend what API does, but instead they will look at tutorials and code snippets, and enter your documentation at random points via Google / StackOverflow links, mostly in cases when something is not working.
I think he means that devs won't be reading documentation like a book, chapter by chapter, trying to comprehend what API does, but instead they will look at tutorials and code snippets, and enter your documentation at random points via Google / StackOverflow links, mostly in cases when something is not working.