Pisanie dokumentacji kodu to często przykry obowiązek. Zobacz gotowe prompty do AI, które zrobią to za ciebie szybko i skutecznie.
Dlaczego warto pisać dokumentację kodu z AI?
Nikt nie lubi pisać dokumentacji, ale wszyscy jej potrzebujemy. AI (np. ChatGPT) może wygenerować czytelne docstringi, opisy funkcji i całych modułów na podstawie samego kodu. Wystarczy dobry prompt.
Podstawowe prompty do dokumentowania funkcji
Oto najprostszy prompt do generowania docstringów w Pythonie:
Oceń poniższą funkcję w Pythonie i napisz dla niej docstring w stylu Google:
{WSTAW KOD FUNKCJI}
Kiedy użyć? Jeśli masz pojedynczą funkcję i chcesz szybko dodać kompletny docstring.
Tip: Zmieniaj styl docstringa (Google, NumPy, reStructuredText) — AI świetnie radzi sobie z formatowaniem!
Prompt do kilku funkcji na raz
Przejrzyj poniższy kod w Pythonie. Do każdej funkcji dodaj kompletny docstring w stylu NumPy:
{WSTAW KOD MODUŁU}
Kiedy użyć? Jeśli chcesz udokumentować cały plik lub klasę za jednym zamachem.
Prompty do dokumentowania klas i metod
Jeśli masz klasę z wieloma metodami, użyj poniższego prompta:
Dodaj docstring główny do poniższej klasy w Pythonie oraz osobne docstringi do wszystkich jej metod. Użyj stylu Google.
{WSTAW KOD KLASY}
Dzięki temu wypełnisz całą klasę czytelną dokumentacją – bez żmudnego opisywania każdej metody z osobna.
Automatyczne tłumaczenie dokumentacji na polski lub angielski
Masz kod z dokumentacją po angielsku, a potrzebujesz wersji po polsku? AI to ogarnie!
Przetłumacz poniższy docstring na polski. Zachowaj formatowanie:
"""
{DOCSTRING}
"""
Działa też w drugą stronę – AI świetnie tłumaczy techniczne opisy z polskiego na angielski.
Prompt do generowania README.md na podstawie kodu
Chcesz README do repozytorium? Użyj takiego prompta:
Na podstawie poniższego kodu projektu napisz czytelny plik README.md po polsku. Uwzględnij opis, wymagania, sposób uruchomienia i przykładowe użycie:
{WSTAW KOD PROJEKTU}
To szybki sposób na wygenerowanie dokumentacji projektu, gdy masz już gotowy kod.
Chain of thought dla lepszej dokumentacji
Jeśli chcesz, żeby AI naprawdę zrozumiała twój kod, zastosuj chain of thought. Najpierw poproś o analizę:
Przeanalizuj poniższą funkcję i wyjaśnij krok po kroku, jak działa. Potem wygeneruj dla niej docstring w stylu Google:
{WSTAW KOD FUNKCJI}
Dzięki temu dostaniesz nie tylko docstring, ale i opis działania, co przydaje się przy złożonym kodzie.
Prompty do dokumentowania kodu w innych językach
- JavaScript/TypeScript:
Dodaj komentarze JSDoc do wszystkich funkcji w poniższym kodzie JavaScript: {WSTAW KOD} - Java:
Dodaj komentarze JavaDoc do wszystkich metod w poniższym kodzie Java: {WSTAW KOD}
Każdy język programowania ma swój standard dokumentacji — AI zna je wszystkie!
Praktyczne tipy: jak wyciskać z AI maksymalnie dobrą dokumentację
- Wklejaj minimalnie potrzebny kod — im mniej „szumu”, tym AI lepiej zrozumie intencje.
- Określaj styl docstringa — napisz w promptcie, czy chcesz Google, NumPy czy inny format.
- Sprawdzaj wygenerowaną dokumentację — AI czasem zmyśla szczegóły!
- Używaj chain of thought przy nietypowym lub skomplikowanym kodzie.
- Zapisuj najlepsze prompty — możesz je potem automatyzować np. w VS Code z Copilotem lub własnym pluginem.
Podsumowanie
Automatyczne generowanie dokumentacji kodu to realna oszczędność czasu. Dobrze napisany prompt pozwala AI wygenerować docstringi, opisy klas czy README szybciej niż kiedykolwiek. Skopiuj powyższe prompty i użyj ich w codziennej pracy — twoja dokumentacja wskoczy na nowy poziom!