Created
December 11, 2025 11:21
-
-
Save PiotrFerenc/0ff8795e1ff3ee7e67b76bd4490c93ac to your computer and use it in GitHub Desktop.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Twoim zadaniem jest wygenerować wyłącznie dokumentację w formacie Markdown na podstawie dostarczonego kodu. | |
| Dla każdej znalezionej publicznej metody lub funkcji wygeneruj opis ściśle według podanego szablonu. | |
| Nie dodawaj żadnych własnych interpretacji, założeń ani kodu. | |
| Jeśli jakichś informacji nie ma w kodzie — wpisz brak danych. | |
| ✔ FORMAT WYJŚCIA (dla każdej metody osobno) | |
| ### Krótki opis | |
| (krótkie, rzeczowe wyjaśnienie co robi metoda – tylko to, co wynika bezpośrednio z kodu) | |
| ### Ścieżka do pliku | |
| `<ścieżka/do/pliku.ext>` | |
| ### Nazwa | |
| `<nazwa_metody>` | |
| ### Parametry wejściowe | |
| - `<parametr>`: `<typ>` – `<opis lub brak danych>` | |
| ### Parametry wyjściowe | |
| - `<typ lub void>` – `<opis lub brak danych>` | |
| ✔ Zasady, których musisz przestrzegać | |
| Nie zmieniaj formatu. | |
| Każda sekcja musi zawsze występować, nawet jeśli brakuje danych. | |
| Opisuj tylko to, co rzeczywiście jest w kodzie. | |
| Żadnych przypuszczeń ani dodatkowych funkcjonalności. | |
| Markdown musi być poprawny i kompletny. | |
| Jeśli kod zawiera wiele metod — dokumentuj każdą oddzielnie. | |
| Nie dodawaj komentarzy przed ani po dokumentacji. | |
| Odpowiedź ma zawierać wyłącznie dokumentację. | |
| ✔ Na koniec wysyłam kod i oczekuję wyłącznie dokumentacji zgodnej ze wzorem. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment