la mejor forma documentar el codigo, cual ¿?

[flashtkd]

la memoria resulta ser muy fragil por lo tanto se pueden olvidar codigos hechos, dificultad para realizar más de una tarea a la vez, dificultad para resolver problemas, tardar más tiempo para llevar a cabo actividades mentales más difíciles, etc.

la mejor solución: es para es documentar el código.

cual es la mejor forma para documentar nuestro código personal ¿?

Eh probado con word pero me tira una lineas rojas diciendo que no es valida la escritura, hasta se toma el descaro de ponerme las letras con mayúscula o cambiando palabras sin mi permiso, lo cual me cambia el código sin querer queriendo, la ventaja de usar word que permite poner imágenes, letras mas decentes, etc.

lo otro es usar block de notas, lo deja todo bien la escritura queda tal cual la deja uno, pero no se puede poner imágenes. la letra queda por defecto sin formato, cuando se tienes muchos bloc de notas queda el desorden.

alguna idea para mejorar la forma de documentar el código ?. cual usas tu ?.

[eulerss]

pues la mejor forma a mi entender es en el mismo código, aunque quiza tenga la desventaja de que el archivo resultante sea un poco mas grande y posiblemente tarde mas tiempo en cargar (hablando de código para una web), otra opcion es replicar el mismo codigo y comentar linea por linea, no se me ocurre otra forma de comentar efectivamente el código, aunque siempre es bueno, tener un word con toda la documentación y requerimientos y demás, dale una leida a ITIL como mejores practicas

saludos

[berthely]

Te mostraté, para este ejemplo buscaré un ejemplo de javascript en internet

ejemplo fuente: http://javascript.mis-algoritmos.com/1

Asi se vé antes de comentar:

Código:

<script language="JavaScript">
<!--
var id,pause=0,position=0;
function scorrevole() {
var i,k,msg="Mensaje bla bla bla bla bla";
k=(100/msg.length)+1;
for(i=0;i<=k;i++) msg+=" "+msg;
document.form2.scorrevole.value=msg.substring(position,position+100);
if(position++==100) position=0;
id=setTimeout("scorrevole()",100); }
//-->
</script>

Despues:

Código HTML:

<script language="JavaScript">
<!--
//variables de trabajo
var id,pause=0,position=0;

//funcion numero uno, aqui
function scorrevole() {
   var i,k,msg="Mensaje bla bla bla bla bla";
   k=(100/msg.length)+1;
   
   //ciclo for
   for(i=0;i<=k;i++) msg+=" "+msg;
   
   //cambiar valores
   document.form2.scorrevole.value=msg.substring(position,position+100);

   //sentencia if
   if(position++==100) position=0;
      id=setTimeout("scorrevole()",100);
   }
//-->
</script> 

Basicamente lo que hago es dejar un espacio en blanco antes de uniciar una línea de comentario, y no dejar espacion de saltos de linea sin poner comentario.

[Gunn3r]

También podrias tener una cuenta en un servicio como http://snipt.net o http://snipplr.com, sitios que permiten almacenar código con etiquetas, descripciones, etc.

[Carlangueitor]

Yo he usado una Herramienta que basada en Adobe AIR (osea que te vale para cualquier S.O) se llama Snippely, guarda trozos de código y los puedes usar cuando quieras:

http://code.google.com/p/snippely/

Saludos