Scribd
Cargar
95 vistas1 página

10mandamientos TallerPython 180409

Este documento presenta 10 mandamientos para el desarrollo de código en Python. Los mandamientos incluyen: amar a Python sobre otros lenguajes; agregar comentarios descriptivos; usar nombres descriptivos para variables y funciones; dividir el código en múltiples funciones pequeñas en lugar de una sola función grande; documentar el propósito del programa y mantener un registro de versiones; documentar cada función y sus parámetros; definir y documentar parámetros al inicio del programa; agrupar parámetros, datos y resultados en estructuras distintas; usar espacios

Cargado por

afp1506
Derechos de autor
© © All Rights Reserved
Nos tomamos en serio los derechos de los contenidos. Si sospechas que se trata de tu contenido, reclámalo aquí.
Formatos disponibles
Descarga como PDF, TXT o lee en línea desde Scribd
95 vistas1 página

10mandamientos TallerPython 180409

Este documento presenta 10 mandamientos para el desarrollo de código en Python. Los mandamientos incluyen: amar a Python sobre otros lenguajes; agregar comentarios descriptivos; usar nombres descriptivos para variables y funciones; dividir el código en múltiples funciones pequeñas en lugar de una sola función grande; documentar el propósito del programa y mantener un registro de versiones; documentar cada función y sus parámetros; definir y documentar parámetros al inicio del programa; agrupar parámetros, datos y resultados en estructuras distintas; usar espacios

Cargado por

afp1506
Derechos de autor
© © All Rights Reserved
Nos tomamos en serio los derechos de los contenidos. Si sospechas que se trata de tu contenido, reclámalo aquí.
Formatos disponibles
Descarga como PDF, TXT o lee en línea desde Scribd
Está en la página 1/ 1

Los 10 MANDAMIENTOS del Taller de Python

1. Amarás a Python por encima de todas las cosas, no idolatraras jamás a falsos becerros de oro (ni Octave, ni
Scilab... Ni siquiera Matlab!). Se pueden ejecutar códigos ya escritos en otros lenguajes, pero no se puede escribir
código nuevo en otro lenguaje que no sea Python (salvo excepciones lógicas: No se programa el LOC en Python,
en un excel puedes añadir una macro sencilla...)

2. Pondrás comentarios a lo largo del código. Los comentarios deben dar sentido físico/real a lo que hace el
código, los comentarios no deben decir lo que ya se ve que hace el código. No debería haber ni insuficientes ni
demasiados comentarios, pero en caso de duda escribirás de más antes que de menos.

3. A las variables, funciones, parámetros... les darás nombres que sean descriptivos del contenido/funcionalidad
pero no sean excesivamente largos y que ayuden a entender el código. Por ejemplo, la posición de elevación del
Sol no debería llamarse ni "p3" ni "elevacionposicionsolengradossiendo0cuandoestaenelhorizonte", podría ser un
nombre adecuado "ELsol"

4. No crearás un programa con una única función que contiene cientos o miles de líneas. Crearás una función
MAIN, que llamara a funciones secundarias. La función MAIN es casi casi un paso a paso, un guion, un índice; las
funciones secundarias contienen prácticamente todo el código. Siempre crearás la función MAIN al inicio del
archivo .py y siempre terminará el archivo .py con “if name=__main__: MAIN()”. En medio estarán las funciones
secundarias. Puede haber funciones de tercer nivel, pero no suelen ser habituales y se debería haber gran cantidad
de funciones anidadas.

5. Al inicio de .py principal escribirás una breve descripción de qué hace el programa (1o2 líneas) y mantendrás
una Trazabilidad de Versiones. Las versiones se numeran con dos números siendo como V=versión y r=revisión.
Se sube de versión cuando hay cambios gordos de funcionalidad o estructura en el código. Se sube de revisión
cuando se han añadido detalles o correcciones a lo que ya había.

6. Al inicio de cada función siempre escribirás una breve descripción de qué hace la función (1o2 líneas) y una
lista de argumentos de entrada y de valores de retorno. Las listas tendrán descripciones de los
argumentos/retornos, incluyendo dimensiones, tipo de variable, unidades, criterios de signos, avisos... Etc

7. Al inicio de .py principal estarán todos los parámetros, indicando sus descripciones, maneras de uso, criterio
de signos, unidades... No habrá parámetros sueltos/diseminados a lo largo del código, ni parámetros con contenido
duplicado. Tampoco debieran existir parámetros que luego el programa no usa para nada.

8. Agruparás parámetros dentro de un objeto/estructura, datos dentro de otro objeto/estructura, resultados


dentro de otro... Etc. Los nombres de estas estructuras siempre serán 3o4 letras en mayúsculas, por ejemplo
DAT=datos, RES=resultados, PLOT=param de ploteo, SAVE=param de guardar resultados en excel/txt/npy

9. Usarás espacios para separar ambos lados de un "=", de un "<", de un "&", de un "+", después de ","... No utilizaras
intro entre líneas que tienen una fuerte relación, pero sí lo utilizarás entre bloques de líneas que hacen cosas
diferentes. Podrás usar dos intros entre partes k son muy muy diferenciadas. Siempre usarás los espacios e intros
de tal manera que leer tu código no genere dolor de cabeza, ni incite al suicidio a un compañero.

10. No estudiaras estos mandamientos al pie de la letra ni te limitaras necesariamente a ellos, sino que usarás el
SENTIDO COMÚN. Pudiendo de este modo ser libre para saltarte leyes si lo consideras justificado/razonable,
autoimponerte nuevas leyes aunque aquí no estén recogidas si las ves necesarias... Evitarás hacer cosas k generan
molestias a tus compañeros aunque no estén escritas y tú no le veas el motivo. Del mismo modo, harás cosas que
ayuden a tus compañeros aun tampoco estén aquí escritas y tú no le veas el motivo.

También podría gustarte