Search type Search syntax
Tags [tag]
Exact "words here"
Author user:1234
user:me (yours)
Score score:3 (3+)
score:0 (none)
Answers answers:3 (3+)
answers:0 (none)
isaccepted:yes
hasaccepted:no
inquestion:1234
Views views:250
Sections title:apples
body:"apples oranges"
URL url:"*.example.com"
Favorites infavorites:mine
infavorites:1234
Status closed:yes
duplicate:no
migrated:no
wiki:no
Types is:question
is:answer
Exclude -[tag]
-apples
For more details on advanced search visit our help page
Results tagged with Search options user 17853

Software documentation is written text that accompanies computer software. It explains how the software operates, how to install it, how to use it, and other resources for help.

5
votes
a programmer, he should not be reading the code. At all. Provide high-level documentation instead. This isn't a reasonable request, is it? No. …
answered Sep 6 '11 by Lightness Races in Orbit
12
votes
I would never consider omitting documentation for internals just because an "end user" won't be using them; code maintenance is more than enough reason to include documentation comments for all …
answered May 31 '11 by Lightness Races in Orbit
2
votes
It sounds like you're putting too much background information in your docstrings, no? Preconditions and postconditions should never be long enough to warrant a concern like this. You could consider p …
answered Feb 25 '16 by Lightness Races in Orbit