Function _comment_narration_findings

scripts/code_verify_rules.py:3033–3074

Scan comment text in @p src_text and emit one finding per banned pattern. Walks every line: `// ...` line comments contribute their tail text, and ` * ...` lines inside a doxygen / block comment contribute their body (minus the leading `*`). String literals and code outside comments are

(
    src_text: str, path: Path, fence_mask: list[bool]
)

def _comment_narration_findings(
    src_text: str, path: Path, fence_mask: list[bool]
) -> list[Finding]:
    """Scan comment text in @p src_text and emit one finding per banned pattern.

    Walks every line: `// ...` line comments contribute their tail text, and
    ` * ...` lines inside a doxygen / block comment contribute their body
    (minus the leading `*`). String literals and code outside comments are
    not visited. @brief lines are skipped.
    """
    if _is_vendored_path(path):
        return []

    out: list[Finding] = []
    lines = src_text.split("\n")
    for i, raw in enumerate(lines, start=1):
        if i - 1 < len(fence_mask) and fence_mask[i - 1]:
            continue

        # `//` line comment -- everything after the marker is prose.
        m_line = re.search(r"//(.*)$", raw)
        # ` * ` doxygen continuation -- a line starting with whitespace + `*`
        # but NOT starting a `*/` close or a `/**` open is prose. The opener
        # `/**` line itself often contains @brief and runs through the
        # @brief filter below.
        m_doxy = re.match(r"^\s*\*\s?(.*)$", raw)

        if m_line:
            text = m_line.group(1)
        elif m_doxy and not m_doxy.group(1).startswith("/"):
            text = m_doxy.group(1)
        else:
            continue

        if _is_brief_line(text):
            continue

        for pat, msg in _NARRATION_PATTERNS:
            if pat.search(text):
                out.append(Finding(i, "comment-narration", msg))
                break  # one finding per line is plenty
    return out


# ---------------------------------------------------------------------------