in reply to Standardising code documentation
You seem to have good engineering intentions with this. So I will say that for that purpose it doesn't quite go far enough. Rather than simply say "why I did this", a programmer should document the entire decision process, including at least the factors that went into the decision and the evaluations. Essentially, the cost/benefit analysis. The risks, the trade-offs.
Otherwise, with what you have, you may as well simply insert a standard header on each program that says "This is a separate program for all the usual reasons."
|
|---|
| Replies are listed 'Best First'. | |
|---|---|
| A reply falls below the community's threshold of quality. You may see it by logging in. |