uOpt
Golden Member
- Oct 19, 2004
- 1,628
- 0
- 0
If you just invented a new algorithm you should explain it in clear text, not have people figure it out from the code. Chances are your implementation isn't quite correct or complete so the latter is a losing proposition.
You should also have a basic overview of where and how program state is being held. I don't see how that's possible without comments.
If you use a standard algorithm but implemented it yourself you should say so. Chances are your implementation isn't correct anyway and it might not be easily recognizable.
The most valuable comments are of this kind "DO NOT TOUCH THIS UNLESS YOU KNOW WHAT YOU ARE DOING".
You should also have a basic overview of where and how program state is being held. I don't see how that's possible without comments.
If you use a standard algorithm but implemented it yourself you should say so. Chances are your implementation isn't correct anyway and it might not be easily recognizable.
The most valuable comments are of this kind "DO NOT TOUCH THIS UNLESS YOU KNOW WHAT YOU ARE DOING".