| [ << Programming work ] | [Top][Contents] | [ Release work >> ] |
| [ < Naming Conventions ] | [ Up : Code style ] | [ Code comments > ] |
10.5.5 Broken code
Do not write broken code. This includes hardwired dependencies, hardwired constants, slow algorithms and obvious limitations. If you can not avoid it, mark the place clearly, and add a comment explaining shortcomings of the code.
Ideally, the comment marking the shortcoming would include TODO, so that it is marked for future fixing.
We reject broken-in-advance on principle.