Universidad Tecnológica de

Panamá
Facultad de Ingeniería de Sistemas Computacionales

Herramientas de Programación Aplicada III

Clase #5: Buenas prácticas de programación

Profesor: Rodrigo Yángüez

Fecha: 13 de abril de 2023
Las convenciones de codificación son un conjunto de normas para un
lenguaje de programación específico que recomiendan estilos de
programación, buenas prácticas y métodos para mantener el aspecto del
código fuente.. Estas convenciones incluyen la organización de archivos, la
identación, los comentarios, las declaraciones los espacio en blanco, las
llaves de apertura y cerrado, etc.
Las razones principales de la existencia de estas convenciones son para reducir los
esfuerzos a la hora de leer y entender el código fuente y mantener el standard de estilo
adecuado al lenguaje de programación, de esta manera nos centramos en revisar los
puntos mas importantes de nuestro código fuente más que en sintaxis y estilos.
Camel Case
El nombre se debe a que las mayúsculas a lo
largo de una palabra en CamelCase se
asemejan a las jorobas de un camello.

Existen dos tipos de CamelCase:

• UpperCamelCase, cuando la primera letra de
cada una de las palabras es mayúscula.
Ejemplo: MiBlogDeDesarrollo.
• lowerCamelCase, igual que la anterior con la
excepción de que la primera letra es
minúscula. Ejemplo: miBlogDeDesarrollo.
snake_case
Snake case es la convención que compone las palabras
separadas por barra baja (underscore) en vez de espacios y
con la primera letra de cada palabra en minúscula. Por
ejemplo mi_blog_de_desarrollo.

Este tipo de convención se utiliza en nombres de variables y

funciones de lenguajes antiguo particularmente asociado
con C. Aunque también lenguajes como Ruby y Python lo
han adoptado.

Igual que el CamelCase existen variedades, por ejemplo

todas las letras en mayusculas de denomina
SCREAMING_SNAKE_CASE utilizado para definir constantes.
kebab-case
Al igual que el snake_case pero unido
con guiones en vez de barra baja. Por
ejemplo herramientas-de-programación-
aplicada-iii

Este tipo de sintaxis se utiliza para las

urls, nombres de paquetes en Composer
y también se utiliza como convención de
nombres en Lisp. Por ello también es
conocido por spinal-case o lisp-case
Train-Case
Es una variedad del kebab-case, pero cada palabra con la primera letra
en mayúsculas. Por ejemplo, Mi-Blog-De-Desarrollo.
Convenciones para la clase
• Nombres de variables: snake_case
• Funciones: camelCase
• Constantes: SNAKE_CASE(usando mayúsculas)
Consejos para documentar código
• Comentarios claros y concisos: Asegúrate de incluir comentarios en tu código
que sean claros y concisos. Explica la funcionalidad del código, su propósito y
cómo se utiliza. Utiliza un lenguaje sencillo y evita jerga técnica innecesaria.
• Documentación en el encabezado: Incluye una descripción breve en el
encabezado de tus archivos de código para indicar su contenido y propósito. Esto
ayuda a otros desarrolladores a entender rápidamente lo que hace el archivo y
cómo se utiliza.
• Uso de nombres descriptivos: Utiliza nombres de variables, funciones y clases
que sean descriptivos y significativos. Evita nombres genéricos o abreviados que
puedan causar confusión. Un nombre bien elegido es parte de la documentación
del código en sí mismo.
• Comentarios en línea: Añade comentarios en línea junto al código para explicar
partes específicas del mismo. Esto es especialmente útil para aclarar secciones de
código complejas o poco intuitivas.
• Documentación de funciones y subrutinas: Asegúrate de documentar
adecuadamente todas las funciones y subrutinas que hayas creado. Incluye una
descripción de lo que hace la función o subrutina, los parámetros de entrada y
salida, y cualquier restricción o consideración importante.
• Formato consistente: Mantén un formato consistente en tus comentarios y
documentación. Utiliza un estilo y una estructura de documentación coherente en
todo tu código para facilitar su comprensión y uso.
Beneficios de una buena documentación
• Ahorro de tiempo de desarrollo a mediano plazo
• Agilidad en el desarrollo
• Evitar creación de código duplicado
• Modularidad
• Escalabilidad
• Fácil identificación de errores
 Buenas prácticas de programación
• Utilizar tipos de datos adecuados: Utiliza los tipos de datos adecuados para las
variables y propiedades en tu código. Evita el uso de tipos de datos implícitos (como
"var") cuando no sean necesarios, ya que puede dificultar la comprensión del código.
• Mantener el código limpio y legible: Escribe código limpio y legible utilizando
indentación y espaciado adecuado. Divide el código en bloques lógicos y utiliza
comentarios para explicar su funcionamiento cuando sea necesario. Evita la
duplicación de código.
• Manejar adecuadamente excepciones: Asegúrate de manejar adecuadamente las
excepciones en tu código.
• Optimizar el rendimiento: Optimiza el rendimiento de tu código utilizando técnicas
eficientes de programación. Evita el uso excesivo de ciclos anidados, y evita el uso de
consultas de base de datos o llamadas de red innecesarias en bucles.
• Utilizar comentarios significativos: Añade comentarios en tu código que sean
significativos y proporcionen información relevante. Explica la lógica detrás del código, su
propósito y cualquier consideración importante. Utiliza un lenguaje claro y evita
comentarios innecesarios o confusos.
• Realizar pruebas unitarias: Implementa pruebas unitarias en tu código para asegurarte
de que funcione correctamente y detectar posibles errores antes de implementarlo en
producción.
• Mantener la seguridad en mente: Ten en cuenta la seguridad al escribir código en Visual
Basic .NET. Evita la inyección de código SQL, la manipulación de URL y otros ataques
comunes.