6 tips de IBM al momento de Programar (Parte 1)

En la página de IBM dan 6 tips para poder escribir código mas comprensible. Aunque la idea principal parte al trabajar en grupos de desarrollo, estos conceptos son básicos también cuando se desarrollan aplicaciones que requerirán soporte ó modificaciones futuras.

Al momento de desarrollar, el factor tiempo adquiere mucha importancia, de hecho, es uno de los recursos más valiosos con los que se cuenta. Por lo que al momento de desarrollar, es importante ser disciplinado y evitar prácticas que nos puedan generar problemas mas adelante. Cada minuto que se ahorre al entender códigos anteriores ó ajenos es ganancia.

Tip 1: Comenta inteligentemente

Siempre se recomienda comentar el código, sin embargo, no gastes tiempo ni recursos con comentarios inútiles.

Muchas veces, nos llegan comentarios que rayan en lo estúpido é innecesario.

// Se incrementa la variable "i" en 1
i = i + 1;

Esto es completamente inútil. Al momento de comentar una buena idea es poner:

• Una descripción corta sobre el funcionamiento general del bloque de código
• Descripción de los parámetros que recibe
• Descripción de lo que regresa
• Si es necesario, dentro de la función describe el funcionamiento de líneas que puedan ser difíciles de interpretar.

/**
La funcion calcula las cantidades de materiales es necesario para fabricar el producto ITM01
Parámetro: $psoTotal Entero – peso total de la formula
Retorno : $cantidad Entero – cantidad en gramos de material base
Function calculaCantidad($psoTotal){
[codigo de la funcion]
}
*/

De esta manera por lo menos sabemos tres cosas, que hace, que recibe y que regresa.

Nota para el Señor, si es que me hace el honor de leer esta onda… sus comentarios de «estaba un día un pequeño saltamontes sorprendido por la complejidad lograda en la funcion siguiente» sirven para ni madres!!!! Usted tiene un compilador en la cabeza… el resto de los mortales que trabajan con su código no!

Tip 2: Usa DEFINE, pero no en exceso

El recurso DEFINE nos permite darle elegancia al código al poder parametrizar valores de una aplicación que son recurrentes en todo el sistema y que en caso de que cambie el ambiente, solamente hay que modificar una línea y no todo el programa.

Por ejemplo, en una sistema basado en Web, se pueden poner como parámetros globales la ruta del servidor, el nombre de la base de datos, los directorios de clases ó imágenes, etc.
define("DB_NAME", "mi_base_de_datos");

Siempre cuidando el equilibrio entre código funcional y código ofuscado.

Tip 3: Usa nombres descriptivos

Una buena practica es usar algún tipo de estándar que permita saber desde el nombre de que se esta hablando. Explico, lo ideal es que por la forma en que esta escrito algo, sepas el tipo de variable, si es un objeto, si es constante, etc… por ejemplo, en los 12 mandamientos de python dice del primer al séptimo enunciado:

1. Los nombres de los módulos deben estar en minúsculas – hola.py
2. Los nombres de las clases deben usar CamelCase
3. Los métodos y funciones deben usar minúsculas_con_guion_bajo
4. Los métodos privados para uso interno comienzan con _guion_bajo
5. Los atributos de clase con __doble_guion_bajo
6. Las constantes en el primer nivel del código (las que no se encuentran dentro de una función o una clase) deben usar LETRASMAYUSCULAS. Usar demasiadas constantes puede hacer que tu código sea menos reutilizable.
7. Si una variable en una función o método es tan temporal que no puedes darle un nombre, utiliza i para la primera, j para la segunda, y k para la tercera.

Puedes usar este estilo ó usar uno propio, lo importante es que sea descriptivo y que lo uses en TODO el desarrollo.

NUNCA uses nombres como «$ variableSusanita» si «Susanita» no tiene nada que ver con el código.!!!

Los otros 3 los damos en otra entrega, porque esto ya se puso muy largo…

Saludos y espero que a alguien le sirva!