doc-generator
Generar Documentación de Python desde Código Fuente
Crear documentación de API manualmente consume mucho tiempo y queda obsoleta rápidamente. Esta habilidad genera automáticamente documentación completa en markdown desde código fuente de Python extrayendo docstrings, type hints y estructura de código en material de referencia bien organizado.
Télécharger le ZIP du skill
Importer dans Claude
Allez dans Paramètres → Capacités → Skills → Importer un skill
Activez et commencez à utiliser
Tester
Utilisation de "doc-generator". Generate documentation for calculator.py
Résultat attendu:
# Calculator Module
Basic arithmetic operations module.
## Functions
### add(a: int, b: int) -> int
Add two numbers together.
**Parameters:**
- a (int): First number
- b (int): Second number
**Returns:**
- int: Sum of a and b
### multiply(x: float, y: float) -> float
Multiply two numbers.
**Parameters:**
- x (float): First number
- y (float): Second number
**Returns:**
- float: Product of x and y
Utilisation de "doc-generator". Document all classes in user_manager.py
Résultat attendu:
# User Manager Module
User account management system.
## Classes
### UserManager
Handles user account operations including creation, authentication, and profile management.
**Methods:**
- create_user(username: str, email: str) -> User: Create new user account
- authenticate(username: str, password: str) -> bool: Verify user credentials
- get_profile(user_id: int) -> UserProfile: Retrieve user profile data
- update_email(user_id: int, new_email: str) -> None: Update user email address
Audit de sécurité
SûrThis skill is a documentation guide with no executable code. All 27 static findings are false positives from markdown code examples and documentation formatting. The skill describes using Python standard library tools for documentation generation with no network access or command execution.
Problèmes à risque faible (1)
Facteurs de risque
📁 Accès au système de fichiers (1)
Score de qualité
Ce que vous pouvez construire
Generación de Referencia de API
Ingenieros de software que construyen bibliotecas de Python pueden generar automáticamente documentación de referencia de API desde su código base con todas las clases, métodos y funciones públicas documentadas en un formato consistente.
Creación de README de Proyecto
Escritores técnicos y mantenedores de proyectos pueden crear rápidamente archivos README completos con ejemplos de uso y documentación de API extraída directamente desde docstrings del código fuente.
Documentación de Código Legacy
Equipos de desarrollo que heredan código base sin documentación pueden generar estructura de documentación inicial desde firmas de código existentes y cualquier docstring disponible como punto de partida.
Essayez ces prompts
Generate documentation for the Python file src/api/handlers.py
Generate comprehensive API documentation for all Python files in the src/services directory
Document all classes in models.py with their methods and attributes
Create a README.md file from the main.py module including usage examples from docstrings
Bonnes pratiques
- Asegúrese de que sus archivos fuente de Python tengan docstrings completos antes de ejecutar la generación de documentación para obtener mejores resultados
- Use formato de docstring consistente en todo su código base como estilo Google o estilo NumPy para obtener salida uniforme
- Especifique si desea incluir métodos privados con guiones bajos iniciales si necesita documentación de API interna
Éviter
- No espere documentación detallada de código sin docstrings ya que la salida solo contendrá firmas
- Evite ejecutar en archivos con errores de sintaxis ya que serán omitidos con advertencias
- No use esto para lenguajes distintos a Python ya que depende del análisis AST de Python