Skip to content

Instantly share code, notes, and snippets.

@PiotrFerenc
Created December 11, 2025 11:49
Show Gist options
  • Select an option

  • Save PiotrFerenc/616dd46c2bc17b0ec9cc239b0133e06b to your computer and use it in GitHub Desktop.

Select an option

Save PiotrFerenc/616dd46c2bc17b0ec9cc239b0133e06b to your computer and use it in GitHub Desktop.
Otrzymasz:
kod źródłowy
wcześniej wygenerowaną dokumentację metod
Twoim zadaniem jest:
A. Wygenerowanie dokumentacji tylko dla metod, które faktycznie znajdują się w kodzie.
B. Dla każdej takiej metody — oprócz jej własnej dokumentacji — wygenerowanie dokumentacji wszystkich metod wywoływanych wewnątrz niej, w szczególności:
metod repozytoriów (repo.*)
metod serwisów (service.*)
każdej innej wywoływanej funkcji lub metody
Każde takie wywołanie traktuj jako osobną metodę, która musi mieć swoją dokumentację według tego samego formatu.
C. Nie dodawaj żadnych informacji, których nie da się wyczytać z:
kodu,
wcześniejszej dokumentacji (tylko gdy dotyczy tej konkretnej metody).
D. Odpowiedzią ma być wyłącznie finalna dokumentacja w Markdown — bez komentarzy i objaśnień.
✔ FORMAT WYJŚCIA (dla każdej metody z kodu)
Najpierw dokumentacja samej metody:
## Metoda: <nazwa_metody>
### Krótki opis
(krótki opis – tylko jeśli znajduje się w dostarczonej dokumentacji tej metody)
### Ścieżka do pliku
`<ścieżka/do/pliku.ext>`
### Nazwa
`<nazwa_metody>`
### Parametry wejściowe
- `<parametr>`: `<typ>` – `<opis>`
### Parametry wyjściowe
- `<typ>` – `<opis>`
---
✔ FORMAT ZAWRTOŚCI METODY (dla każdej wewnętrznej metody wywołanej w kodzie)
Dla KAŻDEGO wywołania, np.:
mojerepo.Wykona();
mojserwis.CosInnego();
Tworzysz osobny blok dokumentacji:
### Dokumentacja zawartości: <nazwa_metody>.<wywołana_metoda>()
### Krótki opis
(krótki opis – tylko jeśli znajduje się w dokumentacji tej metody; jeśli brak → wpisz: brak danych)
### Ścieżka do pliku
`<ścieżka/do/pliku.ext>` (jeśli brak informacji → `brak danych`)
### Nazwa
`<nazwa_obiektu>.<wywołana_metoda>()`
### Parametry wejściowe
- `<parametr>`: `<typ>` – `<opis>` (jeśli brak → `brak danych`)
### Parametry wyjściowe
- `<typ>` – `<opis>` (jeśli brak → `brak danych`)
Każda wywołana metoda dostaje swój blok w takiej kolejności, w jakiej występuje w kodzie.
✔ Zasady restrykcyjne
Nie tworzysz dokumentacji dla metod niewystępujących w kodzie.
Nie modyfikujesz treści wcześniejszej dokumentacji — tylko ją filtrujesz.
Jeśli wcześniejsza dokumentacja nie zawiera opisu, wpisz „brak danych”.
Nie dodajesz żadnych interpretacji, przypuszczeń ani logiki spoza kodu.
Odpowiedź musi być wyłącznie Markdownem z dokumentacją.
✔ Przykład działania (na Twoim kodzie)
Kod:
public void Handle(){
mojerepo.Wykona();
mojserwis.CosInnego();
}
Powinno wygenerować:
## Metoda: Handle
### Krótki opis
brak danych
### Ścieżka do pliku
brak danych
### Nazwa
Handle
### Parametry wejściowe
(brak)
### Parametry wyjściowe
void – brak danych
---
### Dokumentacja zawartości: mojerepo.Wykona()
### Krótki opis
brak danych
### Ścieżka do pliku
brak danych
### Nazwa
mojerepo.Wykona()
### Parametry wejściowe
(brak danych)
### Parametry wyjściowe
brak danych
---
### Dokumentacja zawartości: mojserwis.CosInnego()
### Krótki opis
brak danych
### Ścieżka do pliku
brak danych
### Nazwa
mojserwis.CosInnego()
### Parametry wejściowe
(brak danych)
### Parametry wyjściowe
brak danych
✔ Na końcu rozmowy dostarczę:
kod
wcześniejszą dokumentację
Oczekuję wyłącznie dokumentacji w podanym formacie.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment