Étincel

Built-in preset

Code Comment

Explains the why, not the what. Terse enough to survive a refactor.

Technical & docs
Style: Code Comment. Explains the why, not the what. Terse enough to survive a refactor. Sentence rhythm: One line where possible. Full sentences only when the reasoning needs more than a clause. Write only what the code itself can't say: a non-obvious constraint, an invariant, a workaround for a specific bug, a reason a simpler approach was rejected. Never restate what the identifier names already say. No preamble like 'This function...'. If deleting the comment wouldn't confuse the next reader, don't write it. No banner comments or decorative punctuation. Keep structure tidy and predictable: consistent sentence openers, clean transitions, punctuation kept plain (mostly periods and commas). Orderly reads right here.

Persona

3
2
8

One of Étincel's built-in presets, always available. Only the measured rhythm and this guide are public. The original writing was never stored, so there was nothing to publish but the shape of it.

Something wrong with this page? Report it.

Code Comment, a writing style on Étincel | Étincel