Unable to Test First Example on tsdoc.org Playground

[dev-mcpd]

Hi TSDoc Team!

I couldn't test the very first example on tsdoc.org's site. It generates an error because it starts with a class instead of a comment. Was this the expected behavior?

Thank you for your attention.

export class Statistics {
  /**
   * Returns the average of two numbers.
   *
   * @remarks
   * This method is part of the {@link core-library#Statistics | Statistics subsystem}.
   *
   * @param x - The first input number
   * @param y - The second input number
   * @returns The arithmetic mean of `x` and `y`
   *
   * @beta
   */
  public static getAverage(x: number, y: number): number {
    return (x + y) / 2.0;
  }
}

(1,1): Expecting a leading "/**"

Best regards,
cesardddp (@cesardddp)

[octogonz]

The TSDoc Playground does not include a full JavaScript parser. It simply assumes that the first text it encounters is a /** comment, and ignores everything after the last */.

The error message (1,1): Expecting a leading "/**" seemed reasonable clear to me. Assuming we're not going to implement a JavaScript parser, how would you improve it?

[cesardddp]

Oh... thank you, so I really misunderstood the purpose of the TSDoc Playground.

Maybe this might be a bit confusing for other new users, as it was for me, the fact that the first example fails right away... Or maybe new users like me shouldn't be here haha.

I would just include this in a helper on the playground page to make it clearer that it's not a full JS parser. But considering that this documentation is not for more novice users, this concern might not make sense for this project.

Thank you for your time!