Skip to main content

Function: createCommentProseLintText()

function createCommentProseLintText(comment: Readonly<Comment>): string;

Defined in: _internal/comment-prose.ts:403

Create offset-preserving natural-language text for one source comment.

For JSDoc blocks, only the leading description before the first block tag is retained. The tag section is structural documentation rather than prose for the comment-quality rules.

Parameters​

comment​

Readonly<Comment>

Source comment token.

Returns​

string

Prose text with stable indexing relative to comment.value.