Wednesday, April 19, 2006

minimo de comentarios que debes tener en tus proyectos

el poner comentarios en el codigo fuente, es una de las cosas en que los desarrolladores son realmente malisisimos

pero por favor gente (programadores), haganse un favor ustedes mismos!

por lo menos, pongan comentarios al inicio del archivo de codigo principal, por ejemplo cada vez que inicio un proyecto siempre pongo algo como esto en el primer archivo:

Programa: Nombre del Programa
Escrito por: Eber Irigoyen
en: 19/04/2006
Usa (componentes):
- Indy 9.0.14
- XceedZip 4.5.77.0
- MDAC 2.7
Compilado con: Delphi 7

Descripcion:
- blablabla
- mas bla
- etc...

incluir historia de actualizaciones aqui...

son solo unas cuantas lineas y me dice muchas cosas sobre el proyecto, cuantas veces te has pasado horas rompiendote la cabeza solo porque no sabes que version del componente X uso un @#$& compañero de trabajo?

agregar estas lineas al encabezado solo te va a tomar un minuto, y te va a quitar muchas horas de trabajo despues (o a alguien mas)

lo siguiente seria que cada que haces cambios al proyecto, al menos incluyas una descripcion de los cambios, junto con la version y la fecha

cosas tan simples como esta son parte de ser un mejor desarrollador de software

salu2

2 comments:

mymaster_info said...

Primera de proximas muchas visitas por aqui..


Saludos.

BlackTigerX said...

hombre, pues que bueno que ya tengo un lector =o)

salu2