3 ms·
JSDoc has @fileoverview, but it seems to be rarely (or insufficiently) used, in favor of overdocumenting functions and parameters. On the other hand, I find th
by carussell 9y ago
JSDoc has @fileoverview, but it seems to be rarely (or insufficiently) used, in favor of overdocumenting functions and parameters. On the other hand, I find that I use @fileoverview far more often. Treat it as a way to explain not the tree in front of you, but where it fits into the overall forest.
Here's a comment of mine from a while ago describing how Mozilla's old "Bonsai" tool worked:
https://news.ycombinator.com/item?id=11381815 https://news.ycombinator.com/item?id=11381815