Webstorm: Praca z JSDoc

Webstorm i JSDoc

Tworzenie dokumentacji za pomocą JSDoc można zautomatyzować. Wystarczy, że przed funkcją napiszesz: /** i naciśniesz klawisz Enter:

/**function sum(a, b) {
	return a + b;
}

Zostanie wygenerowana dokumentacja:

/**
 * 
 * @param a
 * @param b
 * @returns {*}
 */
function sum(a, b) {
	return a + b;
}

JSDoc i Typescript

Dodatkowo można poinformować Webstorm, żeby stworzył dokumentację kodu wraz z typami danych.

Czyli mając kod:

/**function sum(a: number, b: number): number {
    return a + b;
}

Możesz wygenerować to:

/**
 *
 * @param {number} a
 * @param {number} b
 * @returns {number}
 */
function sum(a: number, b: number): number {
    return a + b;
}

Żeby tak się stało, upewnij się, że jedna opcja w ustawieniach jest zaznaczona.

Przejdź do Settings (CTRL + ALT + S) -> Editor -> Code Style -> TypeScript. Zakładka: Code Generation. Sekcja Comments i zaznacz opcję: Include types in JSDoc.