Function findJSDocComment

    • Checks for the presence of a JSDoc comment for the given node and returns it.

      Parameters

      • astNode: ESLintOrTSNode

        The AST node to get the comment for.

      • sourceCode: SourceCode
      • settings: {
            maxLines: number;
            minLines: number;
            [name: string]: any;
        }
        • [name: string]: any
        • maxLines: number
        • minLines: number
      • Optionalopts: {
            nonJSDoc?: boolean;
        }
        • OptionalnonJSDoc?: boolean

      Returns Token | null

      The Block comment token containing the JSDoc comment for the given node or null if not found.