Siempre documenten su código, les servira a ustedes y a mas personas de lo que te imaginas.
- Profesor del Tec de Leon –
No te ocurre que cuando lees códigos que hiciste hace algun tiempo, no lo logras entender?.
Bueno, esto pasa por no documentar el código y por no hacer una programación entendible (mas humana), como es esto?, vamos a verlo un poco.
int myFunction(int n)
{
if (n < 2)
return n;
else
return myFunction(n - 1) + myFunction(n - 2);
}
A simple vista entiendes ese código?, y si te dijera que lo que hace es la serie de Fibonacci?.
No es tan sencillo a simple vista, por que nadamas son letras sin sentido para el ojo humano, ademas la palabra myFunction tampoco ayuda de mucho solo para indicarnos que es una Función Personalizada.
Casos como este se dan seguido cuando uno comienza a programar, no se diga del caso de las variables que usamos para los ciclos “i, j, k, … etc.“. O las variables que uno comienza a usar para operaciones básicas (suma, resta, multiplicación, etc..) como son “x, y, z, … etc.“.
Todo esto son cosas comunes en la programación ya que tenemos que pasarlas para comprender la importancia que tiene el no hacerlo de esa manera, – Para los nuevos, esto lo verán después de su primer programa de mas de 1,000 lineas de código – .
Ahora veamos un ejemplo mas entendible:
int Fibonacci(int n)
{
if (n < 2)
return n;
else
return Fibonacci(n - 1) + Fibonacci(n - 2);
}
Curiosamente solo se modifico el nombre de la función y con eso le da sentido a la misma, es decir, el nombre de la función nos dice algo sobre lo que vamos a encontrar dentro de ella, en este caso el calculo de la serie de Fibonacci a la cual le tenemos que pasar un dato entero como parámetro.
Pero vamos que se puede mejorar aplicando algunos comentarios en lugares claves y haciéndolos de una manera entendible.
// Calcula la serie de Fibonacci, recibe un entero como parametro.
int Fibonacci(int n)
{
// Revisa si es la primera o segunda iteración de la recursividad
if (n < 2)
return n;
else
// Aquí se maneja la recursividad de (n -1) + (n - 2) que implica la formula
return Fibonacci(n - 1) + Fibonacci(n - 2);
}
Ahora es mucho mas sencillo entenderlo, claro no explique la serie de Fibonacci en este ejemplo por que no era mi intención hacerlo, mi intención es dar a entender que si creas código con palabras concisas y que tengan un significado que sea relativo a lo que realiza ese bloque de código que quieres programar, vas a tener un código mas entendible y mantenible.
La cuestión de escribir poco, mucho o mejor código con mejores instrucciones, etc… es material de otro Post.
Espero les ayude esto. 
.
esta muy bien cuidado y me encanta que no se tiene que instalar, además de la interaccion que tiene con otros lenguajes, el plugin para PHP y Aptana ahora son mis herramientas de trabajo, debo decir que con Dreamweaver me sentía como si estuviera escribiendo en Notepad ya que el autocompletado y la ayuda que te proporciona como IDE es muy pobre, ahora con el autocompletado de mis propias clases es una excelente ayuda para programar orientado a objetos.