Programování Začátečník ChatGPT

Code dokumentace s JSDoc/docstrings

Vytvoření comprehensive dokumentace pro funkce a třídy.

Vyplňte proměnné

3 polí

Např. čeština

Např. vaše hodnota

Např. vaše hodnota

Náhled promptu

0 znaků
Dokumentuj tento kód:\n\n**Kód:**\n```[JAZYK]\n[KÓD BEZ DOKUMENTACE]\n```\n\n**Documentation Style:**\n- JavaScript/TypeScript: JSDoc\n- Python: Google/NumPy docstrings\n- Java: Javadoc\n- PHP: PHPDoc\n\n**Include:**\n1. **Function/Class description**\n - What it does\n - When to use it\n\n2. **Parameters:**\n - @param name - type - description\n - Default values\n - Optional vs required\n\n3. **Returns:**\n - @returns type - description\n - Possible return values\n\n4. **Examples:**\n - @example with code\n - Common use cases\n\n5. **Throws/Exceptions:**\n - @throws ErrorType - when\n\n6. **Additional:**\n - @deprecated if relevant\n - @see for related functions\n - @since version\n\nJazyk: [JAZYK]. Style guide: [GUIDE].

Legenda

Text v [hranatých závorkách] označuje proměnné, které je třeba vyplnit. Po vyplnění se automaticky nahradí vašimi hodnotami.

Tipy pro lepší výsledky

  • Buďte konkrétní - čím detailnější zadání, tím lepší výsledky
  • Používejte kontext - přidejte relevantní informace pro vaši situaci
  • Experimentujte - zkuste různé varianty a porovnejte výsledky