What are some examples of using JSDoc?

Can you provide some examples of how to use JSDoc in my JavaScript code?

Sure! JSDoc is a great way to document your JavaScript code. For example, you can use it to describe a function like this:

/**
 * Adds two numbers together.
 * @param {number} a - The first number.
 * @param {number} b - The second number.
 * @returns {number} The sum of the two numbers.
 */
function add(a, b) {
    return a + b;
}

What about documenting classes?

Absolutely! Here's how you can document a class:

/**
 * Represents a person.
 * @class
 */
class Person {
    /**
     * Creates a person.
     * @param {string} name - The name of the person.
     */
    constructor(name) {
        this.name = name;
    }

    /**
     * Greets the person.
     * @returns {string} A greeting message.
     */
    greet() {
        return `Hello, my name is ${this.name}!`;
    }
}

Can JSDoc be used for documenting events?

Yes, it can! You can document events like this:

/**
 * Emitted when a user logs in.
 * @event User#login
 * @type {Object}
 * @property {string} username - The username of the logged-in user.
 */