---
title: "Code dokumentace s JSDoc/docstrings - AI Prompt"
description: "Vytvoření comprehensive dokumentace pro funkce a třídy. Hotový prompt s proměnnými – zkopírujte a použijte v ChatGPT, Claude i Gemini."
image: "https://zacinamsai.cz/images/og-default.jpg"
---

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

# Code dokumentace s JSDoc/docstrings

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

  ##   Prompt text 

 **Délka:** Střední 

Dokumentuj tento kód:  

**Kód:**  
&#96;&#96;&#96;[JAZYK]  
[KÓD BEZ DOKUMENTACE]  
&#96;&#96;&#96;  

**Documentation Style:**  
- JavaScript/TypeScript: JSDoc  
- Python: Google/NumPy docstrings  
- Java: Javadoc  
- PHP: PHPDoc  

**Include:**  
1. **Function/Class description**  
 - What it does  
 - When to use it  

2. **Parameters:**  
 - @param name - type - description  
 - Default values  
 - Optional vs required  

3. **Returns:**  
 - @returns type - description  
 - Possible return values  

4. **Examples:**  
 - @example with code  
 - Common use cases  

5. **Throws/Exceptions:**  
 - @throws ErrorType - when  

6. **Additional:**  
 - @deprecated if relevant  
 - @see for related functions  
 - @since version  

Jazyk: [JAZYK]. Style guide: [GUIDE].

  [  Interaktivní tvůrce ](https://zacinamsai.cz/prompts/code-dokumentace-jsdoc/builder) 

 ##   Příklad použití 

### Vstup:

Dokumentuj TypeScript funkci calculateShipping(weight, distance, express). Jazyk: TypeScript. Style: JSDoc with @example.

### Výstup:

/**  
 * Calculates shipping cost based on package weight, delivery distance, and shipping speed.  
 * Uses tiered pricing: standard vs express delivery. Includes fuel surcharge for long distances.  
 *   
 * @param weight - Package weight in kilograms (must be positive)  
 * @param distance - Delivery distance in kilometers (must be positive)  
 * @param express - Whether to use express shipping (default: false)  
 * @returns The calculated shipping cost in USD  
 * @throws {ValidationError} If weight or distance is negative or zero  
 *   
 * @example  
 * // Standard shipping for 5kg package, 100km  
 * calculateShipping(5, 100) // returns 15.50  
 *   
 * @example  
 * // Express shipping  
 * calculateShipping(5, 100, true) // returns 28.50  
 *   
 * @see {@link getDeliveryTime} for estimated delivery times  
 * @since 2.0.0  
 */

### Kde použít tento prompt?

Najděte vhodné AI nástroje pro použití tohoto promptu a maximalizujte jeho efektivitu.

 [ 🔧 Vhodné nástroje ](https://zacinamsai.cz/tools?category=programov%C3%A1n%C3%AD) [ 📖 Návody ](https://zacinamsai.cz/articles?search=ChatGPT) [ 📚 Slovník ](https://zacinamsai.cz/glossary?search=Programov%C3%A1n%C3%AD) 

### Podobné prompty

 [  

  Expert  

####  Advanced AI Features - Deep Dive do Pokročilých Funkcí 

Komplexní průvodce pokročilými funkcemi AI nástrojů - od extended context a multimodality po tool use, streaming, a fine-tuning. Naučte se využívat plný potenciál moderních AI systémů.

  Programování  Zobrazit  

 ](https://zacinamsai.cz/prompts/advanced-ai-features-deep-dive-pokrocilych-funkci) [  

  Expert  

####  Algoritmus optimalizace 

Optimalizace algoritmu z O(n²) na O(n log n) nebo lepší.

  Programování  Zobrazit  

 ](https://zacinamsai.cz/prompts/algoritmus-optimalizace) [  

  Pokročilý  

####  API design s REST best practices 

Návrh RESTful API s dokumentací a error handling.

  Programování  Zobrazit  

 ](https://zacinamsai.cz/prompts/api-design-rest) [  

  Pokročilý  

####  Architekt komplexní SaaS aplikace 

Generování kompletní struktury a UI komponent pro SaaS aplikaci na platformě Lovable.

  Programování  Zobrazit  

 ](https://zacinamsai.cz/prompts/lovable-architekt-komplexni-saas-aplikace) 

### Objevte další AI prompty

 Prozkoumejte naši sbírku Programování promptů a najděte ty, které vám pomohou dosáhnout lepších výsledků.

 [ Další Programování prompty ](https://zacinamsai.cz/prompts?category=coding) [ Všechny prompty ](https://zacinamsai.cz/prompts)

```json
{
        "@context": "https://schema.org",
        "@type": "WebSite",
        "name": "Začínám s AI",
        "alternateName": "zacinamsai.cz",
        "url": "https://zacinamsai.cz",
        "description": "Průvodce světem umělé inteligence - Katalog AI nástrojů, články, prompty a slovník pojmů",
        "inLanguage": "cs",
        "potentialAction": {
            "@type": "SearchAction",
            "target": {
                "@type": "EntryPoint",
                "urlTemplate": "https://zacinamsai.cz/search?q={search_term_string}"
            },
            "query-input": {
                "@type": "PropertyValueSpecification",
                "valueRequired": true,
                "valueName": "search_term_string"
            }
        },
        "publisher": {
            "@type": "Organization",
            "name": "Začínám s AI",
            "url": "https://zacinamsai.cz",
            "logo": {
                "@type": "ImageObject",
                "url": "https://zacinamsai.cz/images/zacinamsai_logo.png"
            }
        }
    }
```
