Documentos de Académico
Documentos de Profesional
Documentos de Cultura
ESTILO DE PROGRAMACIÓN
N1
2
N1
6 ASPECTOS
Nombramiento de Para los nombres utiliza
variables y funciones estándares
- Utilice nombres claros, qué es - Uso de mayúsculas, minúsculas
lo que van a guardar la variable y nombres compuesto
- Evite nombres muy cortos En Python:
(ambigüedad) - El carácter _ para separar las
- Para las funciones utilice palabras
nombres que indiquen lo qué - Los identificadores se escriben
hace la función en minúscula
(calcular_area_triangulo ó - Alfabeto inglés para evitar
problemas de codificación
area_triangulo)
3
N1
6 ASPECTOS
Documentación de funciones
Formato consistente que incluya:
- Descripción: objetivo de la función
- Parámetros: nombre y tipo de cada uno con una breve descripción
- Retorno: descripción de lo que retorna la función y su tipo
4
N1
6 ASPECTOS
Complejidad de las Descomposición de
instrucciones funciones
6 ASPECTOS
Tipado de funciones y Comentarios dentro de
de parámetros las instrucciones
- No exagere, el exceso puede
Los type-hints son opcionales hacer el código difícil de leer
en Python, sin embargo, - Escriba comentarios que
nosotros los usamos: expliquen fragmentos
significativos, no una traducción
de Python a español
- El código el más legible y - Identifique instrucciones
fácil de usar complicadas y documéntelas
- Nos prepara para utilizar - En funciones medianas o largas,
otros lenguajes enumere las etapas con
comentarios
6