Function isValidTsDocComment

  • Checks if the provided code string is a valid TSDoc comment.

    Parameters

    • code: string

      The source code string to be checked.

    Returns boolean

    A boolean indicating whether the provided code string is a valid TSDoc comment.

    Remarks

    This function tests each line of the provided code string against a regular expression that matches the TSDoc comment syntax.

Settings

Member Visibility

Theme

Generated using TypeDoc