Function: getLeadingDocComment()

function getLeadingDocComment(
    sourceCode: SourceCode,
    node: Node
): Comment | null;

Defined in: _internal/doc-comments.ts:241

Get the closest leading documentation block comment attached to a node. A comment is considered attached when it ends on the previous line.

Parameters

sourceCode

SourceCode

node

Node

Returns

Comment | null