167
votes
Accepted
What's the phone number equivalent of example.org?
The North American Numbering Plan reserves 555-01 numbers for fictitious purposes. If you want an example Seattle number, for example, +1 206 555 0100 - +1 206 555 0199 would do.
In the United Kingdom,...
- 16.8k
57
votes
How do I document my code for minimum time review?
IMO the best documentation is the documentation you don't actually need. I also hate writing documentation and comments.
With that being said:
Pick readable and talking names. Don't use n, but ...
- 1,509
41
votes
What's the phone number equivalent of example.org?
An oft-used example phone number is the numeric progression.
(123) 456-7890
It's widely understood that this doesn't mean you should call that number -- it's an example. Additionally, according to ...
- 535
27
votes
How do I document my code for minimum time review?
Treat your code as documentation
Your code is your primary documentation. It precisely describes what the resultant app, library or whatever, actually does. As such, any attempts at speed up the ...
- 39.6k
16
votes
Accepted
How do I document my code for minimum time review?
I must admit I do not agree with some of the things that the other answers recommended, so I'm going to throw my two cents;
Comments
Documentation is extremely helpful for strangers reading your ...
- 318
7
votes
What's the phone number equivalent of example.org?
There aren't any international standards governing phone numbers, except for the internationally agreed country codes.
Each country has its own conventions regarding leading zeros, parentheses, and ...
- 179
5
votes
How do I document my code for minimum time review?
Provide a cover letter
Unless you are in a very technical domain, most questions around the code will not be about the 'how' but about the 'why' or the 'what'.
As such, the way to reduce people from ...
2
votes
Accepted
How to automatically manage documentation
Your question is very broad and cannot be answered in detail. However, here some advices:
The general overview can be very useful, but can quickly degenerate into very abstract literature or ...
- 82.3k
1
vote
How do I document my code for minimum time review?
Although there are one or two apparent points of disagreement among the existing answers, if only in emphasis, I'll try to summarise the usual advice in a way that makes clear where everyone's been ...
- 335
1
vote
How do I document my code for minimum time review?
The biggest speed gain I usually get from building separate commits that each represent an intermediate step that compiles and works.
So if I have to introduce a new parameter to a function in order ...
- 1,618
Only top scored, non community-wiki answers of a minimum length are eligible