method-shorthand-jsdoc

Skill dla deweloperów pracujących z funkcjami fabrykującymi w TypeScript i JavaScript. Rozwiązuje problem utraty dokumentacji JSDoc w metodach zwracanych z obiektu — gdy najedziesz kursorem na metodę, IDE nie pokazuje komentarzy. Technika polega na przeniesieniu funkcji pomocniczych bezpośrednio do obiektu zwracanego, używając skrótu metody. Dzięki temu dokumentacja pozostaje widoczna dla konsumentów kodu i IDE poprawnie wyświetla tooltips z opisami parametrów i zwracanych wartości.

1. Zidentyfikuj funkcję fabrykującą, która zwraca obiekt z metodami. Sprawdź, czy wewnątrz funkcji masz funkcje pomocnicze (helpery), które są używane tylko przez metody zwracane w obiekcie — to są kandydaci do przeniesienia.

2. Skopiuj definicję funkcji pomocniczej wraz z jej komentarzem JSDoc. Upewnij się, że masz pełny tekst dokumentacji, w tym @param, @returns i inne adnotacje.

3. W obiekcie zwracanym zastąp przypisanie funkcji (np. getEpoch) skrótem metody — przenieś ciało funkcji bezpośrednio do definicji metody w obiekcie, zachowując komentarz JSDoc tuż nad nią.

4. Zaktualizuj wszystkie miejsca w kodzie, gdzie funkcja pomocnicza była wywoływana — zmień je na wywołania przez this lub bezpośrednie odwołania do metody w obiekcie.

5. Przetestuj w swoim IDE — najdź kursor na metodę zwracaną z fabryki i sprawdź, czy tooltip wyświetla dokumentację JSDoc. Jeśli dokumentacja jest widoczna, zmiana została zastosowana poprawnie.

6. Powtórz proces dla pozostałych funkcji pomocniczych, które powinny być dostępne konsumentom kodu z dokumentacją.