TE
TechEcho
Home24h TopNewestBestAskShowJobs
GitHubTwitter
Home

TechEcho

A tech news platform built with Next.js, providing global tech news and discussions.

GitHubTwitter

Home

HomeNewestBestAskShowJobs

Resources

HackerNews APIOriginal HackerNewsNext.js

© 2025 TechEcho. All rights reserved.

Code Documentation

17 pointsby antoniosalmost 15 years ago

2 comments

thangalinalmost 15 years ago
Business owners seldom see:<p>(1) The business requirements met by the code.<p>(2) The extent of the source code documentation.<p>(3) The quality of the comments (i.e., direction for future maintainers versus profanity, song lyrics, or obscure references).<p>(4) The time it takes to document code and its added business value.<p>I would like to see an editor that links, rather than embeds, source code comments with documentation, while allowing the documentation to be extracted independently. Such as:<p><a href="http://www.youtube.com/watch?v=u3QqjhzhnAw#t=1m41s" rel="nofollow">http://www.youtube.com/watch?v=u3QqjhzhnAw#t=1m41s</a>
jsharpealmost 15 years ago
I'd be interested to know what a lot of these projects are. That graph suggests that there are a good number of projects that have &#62; 90 comment lines per 100 lines, which just seems absurd.<p>Do they count perl one-liners where there is a huge amount of functionality packed into a single line, with a big comment above it explaining what it does?