Documentación y herramientas de desarrollo (CLASE)

Buenas noches, en esta entrada comentaré acerca de la importancia de la documentación de un programa y/o proyecto de programación.

Primero que nada, ¿qué significa documentación?

Bueno, según Wikipedia, se define a Documentación como la ciencia del procesamiento de la información. Integradora y globalizadora, se trata de una ciencia enriquecedora y generalista, de ámbito multidisciplinar o interdisciplinar.

 Ahora bien, en mi opinión la documentación es una herramienta muy útil, ya que gracias a ella podemos tener acceso a sin fin de información que pudiéramos necesitar en algún momento, tanto si fue algo que hicimos hace tiempo y necesitamos volver a repasarlo o que alguien mas la haiga compartido para ayudar a quien se encuentre atorado en "x" problema. Además que si en un determinando momento tienes que abandonar el proyecto que estas realizando, la documentación que hallas desarrollado al inicio de este servirá para que el programador que ocupe tu lugar, continue desarrollando el proyecto en base a la filosofía original que documentaste al principio de este.

En el ámbito de la programación la documentación juega un papel crucial para aquellos que estamos desarrollándonos en esta profesión, nos permite conocer variadas herramientas para implementar en nuestros programas y así facilitarnos el desarrollo de estos como también adaptar estrategias o seguir consejos o experiencias por parte de otros programadores que realizan tales documentaciones de sus trabajos y proyectos para ayudar a otros que apenas empezamos o aquellos que ya saben pero quieren desarrollarse aún más.

Bien, ahora la herramienta que utilizaré para la documentación de mi proyecto será JAVADOC

Y para ello me basaré, en el tutorial que proporciona el mismo JAVA, localizado en la siguiente liga:

http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html

La metodología que pretendo practicar para la documentación de mi proyecto es hacerlo cada que considere que tal avance ya no sufriría modificaciones, que ya tenga algo "seguro" para así poder documentarlo.

Además encontré una herramienta muy útil para hacer la documentación de Java también, se llama DrJava pueden descargarlo y ver más información sobre esta herramienta aquí:

http://www.drjava.org/

Y si lo instalan el procedimiento para crear tu JAVADOC esta aquí:


http://www.drjava.org/docs/quickstart/ch04s02.html



Es todo por esta entrada saludos, y que tengan muy buenas noches :)