Skip to main content

All Questions

28 votes
2 answers
52k views

How to do documentation for code and why is software (often) poorly documented?

There are some good examples of well-documented code out there, such as java api. But, a lot of code in public projects such as git and internal projects of companies is poorly documented and not very ...
Erran Morad's user avatar
10 votes
6 answers
1k views

Hyperlinked, externalized source code documentation [closed]

Why do we still embed natural language descriptions of source code (i.e., the reason why a line of code was written) within the source code, rather than as a separate document? Given the expansive ...
Dave Jarvis's user avatar
5 votes
5 answers
3k views

How to make sure the application source code has a proper documentation for new programmers? [duplicate]

Possible Duplicate: How much documentation is enough? Do you know how the big IT company like IBM, Microsoft, or google make sure their application source code has proper documentation for future ...
null's user avatar
  • 155