Code Commenting

Concise, layered commenting that explains why and what role code plays — never restates what the code already says.

File-level header

Every new file gets a /** */ block at the top, before imports. Two to four lines max.

Pattern:

/**
 * Short name or role of this file.
 *
 * One or two sentences of context: what it does, where it fits,
 * and any non-obvious constraints or scope limits.
 */

Good — concise, adds context: