Comentarios en Java

Por 9.99€ al mes tendrás acceso completo a todos los cursos. Sin matrícula ni permanencia.

Curso de Java

11.  
22.  
public class B_comentarios {
	public static void main(String[] args) {
		//Esto es un comentario de una sola linea
		/*
		 * Y esto un comentario de varias lineas
		 * */
		System.out.println("Hola Mundo2"); // Hola Mundo2
	}
}

Java Doc

¿Qué es Java Doc?

Es una herramienta que nos da Java, fundamentalmente para documentar métodos y clases, permitiendo, posteriormente su consulta, en tiempo de desarrollo.

¿Cómo documentar con Java Doc?

Escribimos encima de una clase o de un método

/**

y pulsamos enter.

package com.pablomonteser.comenarios;

/**
 * Representa una entidad capaz de realizar las operaciones aritméticas básicas
 * @author Pablo Monteserín
 * @version 1.0
 */
public class Calculadora {

	/**
	 * Calcula la suma de dos números enteros
	 * @param num1: primer número que interviene en la suma 
	 * @param num2: segundo número que interviene en la suma
	 * @return la suma de ambos números
	 */
	public int sumar(int num1, int num2) {
		return num1 + num2;
	}

	public static void main(String[] args) {
		Calculadora calculadora = new Calculadora();
		int sol = calculadora.sumar(3,5);
		System.out.println(sol);
	}
}

¿Cómo usamos JavaDoc?

Al pasar el cursor por encima de una clase o un método, se nos mostrará la documentación que hemos realizado.

También, en el caso de los métodos, al poner el punto anterior al método se mostrará la documentación pertinente.