Ver Mensaje Individual
  #2 (permalink)  
Antiguo 13/11/2005, 12:09
monorendon
Usuario no validado
 
Fecha de Ingreso: octubre-2005
Ubicación: En mi casita
Mensajes: 100
Antigüedad: 19 años, 2 meses
Puntos: 0
Hola, mira yo he buscado bastantes reglas de documentación de código y además si lo utilizas bien puedes generar documentación de tus clases...

Alli te va un ejemplo de lo que utilizo...

Código:
/*
 * @(#)     Demo.java
 * Fecha:   13/11/2005
 * Hora:    12:29:07 PM
 * Copyrigth (c) 2004 - 2005 Intellect® Corp.
 * Dirección, Ciudad, Provincia, País.
 * Todos los derechos reservados.
 */
package declaracion.del.package.demo;

import clases.importadas.Clase;
import java.util.*;
...
/**
 * Descipcion de la Clase Demo
 * Una breve descripción de la clase...
 * @author Tus Nombres
 */
public class Demo extendes ClasePadre implements OtrasClases, ... thows MisExcepciones, ... {
    /**
     * Atributos de la Clase Demo
     */
    public String variable1;
    public String variable2;

    /**
     * Constructor <code>Demo</code>.
     *
     * @param parametro que hace el parametro.
     * ...
     */
    public Demo (String parametro, ...) {
        ...
    }

    /**
     * Método <code>nombreMetodo</code> hace esto esto y esto otro.
     * Más especificaciones (puede incluirse codigo html)
     *
     * @param miParametro sirve para que el método haga esto otro.
     * @return <code>lo que retorna</code> si se cumple algo; caso contrario <code>retorna otra cosa</code>.
     */
    public TipoRetorno nombreMétodo (String miParametro) {
        ...
        return algo;
    }

   ...
}
y si quieres sigues poniendo más métodos... Bueno si te ha servido de algo me avisas y si quieres más información mándame un mail...