Clases en Java

La definición de una clase debe ser escrita en un archivo independiente. El nombre del archivo debe llamarse igual que la clase y tendrá la extensión .java. El nombre de todas las clases sigue el modelo camelCase pero con la primera letra en mayúscula.

Por ejemplo, para definir la clase Persona crearemos el archivo Persona.java y dentro de este definimos la clase con la palabra reservada class:

class Persona {
    // Definición de la clase
}

El comentario para documentar una clase se coloca justo encima de la definición de la clase. Debe describir el propósito de la clase, sus principales responsabilidades, los atributos y métodos principales, y cualquier otra información relevante, como el uso típico de la clase.

Ejemplo:

/**
 * Esta clase representa un Coche con un modelo, marca y velocidad.
 * 
 * Proporciona métodos para acelerar, frenar y mostrar la información del coche.
 * 
 * @author NombreDelAutor
 * @version 1.0
 * @since 2024-10-16
 */
public class Coche {
    // ...
}

Estructura de la documentación de una clase:

• Descripción general: La primera parte del comentario debe ofrecer una breve descripción del propósito de la clase. Aquí indicas qué representa o modela la clase y cuál es su uso principal.
• @author: Nombre de la persona o equipo que creó la clase.
• @version: Versión de la clase. Se usa para indicar cuándo fue creada o modificada.
• @since: Indica la versión o fecha en la que la clase o método está disponible (opcional, pero útil en proyectos con varias versiones).