devseniorlabpython / devseniorlabpython/hardware-shop
Añadir Docstrings y Type Hinting a las Funciones de `main.py`
- 主要語言
- Python
- 星號
- 0
- 分支
- 4
- PR 合併指標
- 30 天內沒有已合併 PR
描述
Un código de alta calidad no solo funciona, sino que también es fácil de leer y entender para otros desarrolladores. Los `docstrings` (cadenas de documentación) y `type hints` (pistas de tipo) son fundamentales para lograrlo.
**Tu Misión:**
Revisar el archivo `main.py` y asegurarse de que todas las funciones tengan docstrings claros y que sus parámetros y valores de retorno estén correctamente tipados.
**Tareas Específicas:**
1. **Revisar `mostrar_menu()`:**
* Esta función ya tiene un buen docstring. ¡Úsalo como ejemplo!
* Asegúrate de que su definición incluya el tipo de retorno: `def mostrar_menu() -> None:`. `None` se usa porque la función no devuelve ningún valor, solo imprime en pantalla.
2. **Revisar `main()`:**
* Añade un docstring que explique el propósito general de la función (ej. "Función principal que inicia el bucle del menú y gestiona la interacción del usuario.").
* Añade el tipo de retorno `-> None` a su definición.
3. **Revisar el Bloque `if __name__ == "__main__":`:**
* Añade un comentario simple encima de este bloque explicando por qué está ahí (ej. `# Punto de entrada para ejecutar la aplicación.`).
**¿Por qué es importante?**
* **Docstrings:** Permiten que herramientas como VS Code muestren ayuda contextual sobre una función cuando pasas el ratón por encima. También son usados por generadores de documentación automática.
* **Type Hints:** Ayudan a prevenir errores al permitir que los analizadores de código estático (como el que usa VS Code) detecten si estás pasando un tipo de dato incorrecto a una función.
**Objetivos de Aprendizaje:**
* Escribir documentación clara y concisa siguiendo los estándares de Python (PEP 257).
* Utilizar el sistema de tipado estático de Python (PEP 484).
* Entender la diferencia entre un comentario (`#`) y un docstring (`"""..."""`).
* Mejorar la
貢獻指南
這個儲存庫沒有索引到貢獻指南
研究方向
開啟 main.py,檢查 mostrar_menu()、main() 以及 if __name__ == "__main__": 區塊。以現有的 mostrar_menu() docstring 作為樣式參考,然後確認所有函式都有清楚的 docstring,並為參數和回傳值提供型別註記。完成的標準是:main() 的註記回傳 None、進入點區塊包含說明性註解,而且檔案仍然可以執行。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- python
- 領域
- documentation
- Issue 類型
- 文件
- 難度
- 1/5
- 預估耗時
- 1 小時以內
- 活躍度
- 停滯
- 描述清晰度
- 描述清楚
- 新手友好度
- 85/100