3 ms·
The only justification I can give to “$documentId - The ID of a document” style comments would be if they are alongside comments that actually give context. If
by jonwest 3y ago
The only justification I can give to “$documentId - The ID of a document” style comments would be if they are alongside comments that actually give context.
If there are 5 parameters, and 3 of them are helped with a bit of context, then adding superfluous comments to the other two makes sense because that in itself is a piece of documentation (parameters needed for a function or class).
If all of your comments are like that though? Gross.