Promptowanie.com.pl

Biblioteka promptów

Komentarze i dokumentacja do kodu

Docblocki, komentarze tam, gdzie kod nie jest oczywisty, i krótki README.

Prompt – 3 zmienne do uzupełnienia 

Dodaj dokumentację do poniższego kodu w [JĘZYK PROGRAMOWANIA].

Zasady:
- docblock dla każdej funkcji i klasy (parametry, zwracana wartość, wyjątki),
- komentarze tylko tam, gdzie kod nie mówi sam za siebie – wyjaśniaj „dlaczego”, nie „co”,
- nie zmieniaj logiki kodu,
- na końcu krótki README: do czego służy, jak uruchomić, jakie ma zależności.

Komentarze pisz w języku: [JĘZYK KOMENTARZY].

[WKLEJ KOD]

Kiedy użyć tego promptu

Gdy kod działa, ale nikt poza autorem go nie rozumie – przed przekazaniem projektu, zatrudnieniem nowej osoby albo po prostu dla siebie za pół roku. Dobre komentarze wyjaśniają „dlaczego”, a nie „co”, i prompt tego pilnuje. Przy okazji powstaje krótki README.

Przykład

Przykładowe dane do uzupełnienia:

  • JĘZYK PROGRAMOWANIA: PHP 8.1
  • JĘZYK KOMENTARZY: polski

Czego się spodziewać: Dla klasy generującej raporty dostaniesz docblocki z typami parametrów i zwracanych wartości, komentarze tylko przy nieoczywistych decyzjach (np. dlaczego daty są przeliczane na strefę czasową klienta) i krótki README z instrukcją uruchomienia.

Jak dopasować prompt do siebie

  • Projekt zespołowy: poproś o komentarze po angielsku i zgodność ze standardem (np. PSR, JSDoc).
  • Stary kod bez testów: poproś dodatkowo o wskazanie miejsc, które wyglądają na błędy.
  • Dokumentacja dla klienta: poproś o osobny opis działania bez szczegółów technicznych.

Wskazówki

  • Sprawdź, czy model nie zmienił kodu – porównaj pliki narzędziem do porównywania.
  • Komentarze typu „zwiększa i o 1” usuń – nic nie wnoszą.
  • Usuń dane dostępowe z kodu przed wklejeniem.

Najczęstsze błędy

  • Komentarz przy każdej linii – kod staje się mniej czytelny.
  • Dokumentacja, która opisuje, co kod robił dawno temu, a nie teraz.

Podobne prompty

ChatGPTClaude

Przegląd kodu PHP pod kątem bezpieczeństwa

Przejrzyj poniższy kod PHP z [WTYCZKA LUB MOTYW WORDPRESS] pod kątem bezpieczeństwa.

Sprawdź: escapowanie wyjścia, sanitizację wejścia, nonce, uprawnienia (current_user_can), zapytania SQL ($wpdb->prepare), przesyłanie plików i przekierowania.

Dla każdego problemu podaj:
- linię,
- ryzyko (wysokie/średnie/niskie) i jak można je wykorzystać,
- poprawiony fragment.

Na końcu wypisz rzeczy, które są zrobione dobrze.

[WKLEJ KOD]
ChatGPTClaudeCopilot

Przepisanie kodu z jQuery na czysty JavaScript

Przepisz poniższy kod z jQuery na czysty, nowoczesny JavaScript (bez bibliotek).
Gdzie działa kod (strona, CMS, wtyczka): [KONTEKST].
Jakie przeglądarki muszą być obsługiwane: [PRZEGLĄDARKI].

Kod:
[WKLEJ KOD]

Wymagania:
- zachowaj dokładnie to samo działanie,
- querySelector/querySelectorAll, addEventListener, fetch zamiast $.ajax,
- delegowanie zdarzeń tam, gdzie elementy dodawane są dynamicznie,
- uruchamianie po załadowaniu DOM (DOMContentLoaded albo atrybut defer),
- krótkie komentarze przy fragmentach, które działają inaczej niż w jQuery,
- na końcu: lista różnic w działaniu, które trzeba przetestować (np. animacje, obsługa błędów AJAX).
ChatGPTClaude

Plan kopii zapasowych i odtwarzania

Pomóż przygotować plan kopii zapasowych i odtwarzania dla systemu.
Systemy i dane: [SYSTEMY / DANE]
Środowisko: [SERWER / CHMURA / CMS]
Dopuszczalna utrata danych: [RPO]
Docelowy czas przywrócenia: [RTO]
Ograniczenia kosztowe i prawne: [OGRANICZENIA].

Zaproponuj częstotliwość kopii, typy backupów, retencję, szyfrowanie, odseparowanie kopii od środowiska produkcyjnego, monitoring i procedurę odtworzenia. Dla każdego elementu podaj ryzyko, odpowiedzialną rolę i sposób testowania. Uwzględnij scenariusz przypadkowego usunięcia, awarii sprzętu, przejęcia konta i zaszyfrowania danych.

Nie zakładaj, że backup działa, dopóki odtworzenie nie zostanie przetestowane. Oznacz decyzje zależne od infrastruktury, regulacji i budżetu.