Skip to content

Importing code snippet from jsdoc, tsdoc @example #1316

@soc221b

Description

@soc221b

Is your feature request related to a problem? Please describe.

It would be better to write examples in single place.

Describe the solution you'd like

Input:

<<< @/snippets/snippet-with-example.js...? 

Code file:

/**  * Adds two numbers together.  *   * @example  * Here's a simple example:  * ```  * // Prints "2":  * console.log(add(1,1));  * ```  *   * @example  * Here's an example with negative numbers:  * ```  * // Prints "0":  * console.log(add(1,-1));  * ```  */ export function add(x: number, y: number): number { }

Output:

Here's a simple example:

// Prints "2": console.log(add(1,1));

Here's an example with negative numbers:

// Prints "0": console.log(add(1,-1));

Describe alternatives you've considered

No response

Additional context

No response

Validations

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions