3 ms·
The problem domain of the source code dictates the value of the comments. If the code is highly algorithmic or data structure driven its more useful to include
by dman 14y ago
The problem domain of the source code dictates the value of the comments. If the code is highly algorithmic or data structure driven its more useful to include a pointer to a book / paper rather than littering the code with comments which will never do as good a job at exposition as a book / paper.
On the other hand arcane business logic needs to be documented because there is no way to recreate that from a mental model.
- angersock 14y agoGenerally I would agree with this--the problem is that citing papers/books/sites can result in brittle, broken external references. Ideally both a brief explanation and a link to the source material would be helpful.