Sugerencias de Codificación

El siguiente ejemplo muestra cómo se formatea un fichero fuente Java que contiene solamente una clase pública. Los interfaces se formatean de modo semejante. Más información al hablar de la declaración de clases e interfaces y de los comentarios de documentación.

/*
 * %W% %E% Nombre Apellido
 *
 * Copyright (c) 1993-1996 Sun Microsystems, Inc. All Rights Reserved.
 *
 * This software is the confidential and proprietary information of Sun
 * Microsystems, Inc. ("Confidential Information").  You shall not
 * disclose such Confidential Information and shall use it only in
 * accordance with the terms of the license agreement you entered into
 * with Sun.
 *
 * SUN MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF
 * THE SOFTWARE, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
 * TO THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
 * PARTICULAR PURPOSE, OR NON-INFRINGEMENT. SUN SHALL NOT BE LIABLE FOR
 * ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
 * DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES.
 */

package java.blah;
import java.blah.blahdy.BlahBlah;

/**
 * Aquí va la descripción de la clase.
 *
 * @version     1.10 04 Oct 1996
 * @author      Nombre Apellido
 */
public class Blah extends SomeClass {
    /* Aquí se colocaría el comentario a la implementación de la clase. */
    /** Comentario de documentación para classVar1  */
    static public int classVar1;
    /** 
     * Comentario de documentación para classVar2 que ocupa
     * más de una línea
     */
    static private Object classVar2;

    /** Comentario de documentación para instanceVar1 */
    public Object instanceVar1;

    /** Comentario de documentación para instanceVar2 */
    protected int instanceVar2;

    /** Comentario de documentación para instanceVar3 */
    private Object[] instanceVar3;

    /** 
     * ...comentario de documentación para el método Blah...
     */
    public Blah() {
        // ...aquí irá la implementación del método...
    }

    /**
     * ...comentario de documentación para el método doSomething...
     */
    public void doSomething() {
        // ...aquí irá la implementación del método... 
    }

    /**
     * ... comentario de documentación para el método doSomethingElse...
     * @param someParam descripción
     */
    public void doSomethingElse( Object someParam ) {
        // ... aquí irá la implementación del método... 
    }
}

Home | Anterior | Siguiente | Indice | Correo