[SOLUCIONADO] Como documentan cambios del código

[wowsumnus]

Estoy aprendiendo java y es mi primer año, estoy en un superior de DAM y tengo las típicas cosas que a todos les pasa, termino mi ejercicio y cuando veo el de la maestra es muchísimo mejor. Cuando esto ocurre yo y toda mi clase simplemente cambia el código y ya, pero yo con mis poquisisisisisimos 3 meses peleándome con java ya, he pensado como documentaran el código en un trabajo los profesionales como vosotros?

¿Quiero decir ponen comentarios típicos?, ¿usan alguna herramienta? o ¿Simplemente borran el código que es ineficiente y pone el eficiente?.

Todo a sucedido porque me gustaría ver como voy avanzando y recordar mis fallos y que esas cosas no las puedo hacer ademas de una intriga de como se hace eso, entonces me gustaría saber como lo cambian :)

Muchas gracias por vuestra ayuda y tiempo! :)

[chuidiang]

Hola:

Depende de lo serio que sea el proyecto.

Lo más habitual es usar un sistema de control de versiones (git, subversion, etc). Estos sistemas de control de versiones te guardan todo el histórico de los fuentes y admiten comentarios que tu escribas para cada cambio, por lo que si se hace bien, queda todo registrado, se pueden comparar versiones para ver exactamente qué líneas han cambiado, recuperar versiones antiguas, etc. Si no los conoces, echa un ojo a cualquier proyecto guardado en github https://github.com/

Si el proyecto es muy serio y el cliente muy exigente, puede ponerse como comentario en los fuentes la fecha de cada cambio, quién lo ha cambiado y por qué. De todas formas, hasta donde yo sé, esto está muy en desuso porque los sistemas de controles de versiones ya lo hacen.

Se bueno.

[Malenko]

- Esta prohibido documentar lo que hace el código ya que este ha de ser entendible
- Solo se permite comentar con los tags de documentación de código (javadoc, por ejemplo)

Si eliges buenos nombres para tus variables y métodos y haces funciones cortas, el código tendría que ser legible sin ayudas extras. Se estructurado y metódico y tendrás mucho ganado. El meter comentarios "inútiles" que no aportan nada lo único que hacen es generar "ruido" y "volumen" en el fichero de código y provocar que un método que podrías leer en una pantalla sin hacer scroll, tengas que desplazarte para poder leer la función entera (dificultando su entendimiento).

Sobre los comentarios de cambios en el código, es la función de los gestores de control de versión: al hacer el "check-in" has de indicar que se ha modificado y porque.

P.D.: Estas son las normas que uso en un proyecto en le que estoy trabajando actualmente y la verdad es que si programas bien no tienes ningún problema a la hora de leer el código.