Instruction file imported from briangmilnes/APAS-VERUS (.cursor/rules/apas-verus/comment-style.mdc). Copyright stays with the author.

Comment Style

Do not use decorative separator lines or box-drawing characters in code comments.

Bad:

// ============================================================
// Section Name
// ============================================================

Bad:

// --------------------------------------------------------
// Another section
// --------------------------------------------------------

Bad:

// ── Anvil-style vec_filter: multiset equality postcondition ──────────

Bad:

    // ========================================================================
    // f64 implementation
    // ========================================================================

Bad:

// ---

Good: Just a plain comment, no decoration.

// Section Name

Good: Doc comment.

/// Section documentation

Good: Full sentence.

// Anvil-style vec_filter using a multiset equality postcondition.

Decorative separators and box-drawing characters (─, ═, etc.) are acceptable in:

• Log output
• Terminal output
• Markdown documentation
• README files

But never in source code comments.