Documentar un programa es tedioso;
pero absolutamente necesario para que otros lo entiendan.
En el caso de la asignatura,
documentar los programas es absolutamente necesario
para que los profesores lo entiendan.
En Java, la documentación se hace por medio de javadoc.
A continuación se muestra un programa documentado, que se comenta más abajo:
1 /**
2 * Ejemplo: círculos.
3 *
4 * @author José A. Mañas - fprg5000
5 * @version 23.9.2005
6 */
7 public class Circulo {
8 private double centroX;
9 private double centroY;
10 private double radio;
12 /**
13 * Constructor.
14 * @param cx centro: coordenada X.
15 * @param cy centro: coordenada Y.
16 * @param r radio.
17 */
18 public Circulo(double cx, double cy, double r) {
19 centroX = cx;
20 centroY = cy;
21 radio = r;
22 }
24 /**
25 * Getter.
26 * @return centro: coordenada X.
27 */
28 public double getCentroX() {
29 return centroX;
30 }
48 /**
49 * Calcula la longitud de la circunferencia (perímetro del círculo).
50 * @return circunferencia.
51 */
52 public double getCircunferencia() {
53 return 2 * Math.PI * radio;
54 }
64 /**
65 * Desplaza el círculo a otro lugar.
66 * @param deltaX movimiento en el eje X.
67 * @param deltaY movimiento en el eje Y.
68 */
69 public void mueve(double deltaX, double deltaY) {
70 centroX = centroX + deltaX;
71 centroY = centroY + deltaY;
72 }
74 /**
75 * Escala el círculo (cambia su radio).
76 * @param s factor de escala.
77 */
78 public void escala(double s) {
79 radio = radio * s;
80 }
81 }