method-shorthand-jsdoc

Move helper functions into return objects using method shorthand for proper JSDoc preservation. Use when factory functions have internal helpers that should expose documentation to consumers, or when hovering over returned methods shows no JSDoc.

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ą.