Cursos Empresas Blog Live Conf Eventos Precios

Ahora que ya conoces las tags y su uso para documentar, te pongo el siguiente reto que consiste en general la documentación para librería Report, que creamos en el Curso Básico de Java SE el proyecto lo encuentras aquí: https://github.com/anncode1/JavaSEBasico/tree/26.EscribirArchivos

Genera la librería documentada e implementala en el proyecto. Compártenos pantallazos de qué etiquetas usaste y cómo se ve ahora.

Documentación de librería Report en Java SE

Curso Avanzado de Java SE

Clase 8 de 40

Clase 8 / 40

José Francisco Casales Huerta

Hace 8 años

Asi quedo mi libreria documentada

package com.codecasales.makereport;

import java.io.BufferedWriter;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStreamWriter;

/**
 * <h1>Make Report</h1>
 * Clase que se encarga de escribir archivos de texto
 * <br>
 * Escribe documentos de texto a partir de los atributos {@code nameFile}, {@code title}
 * y {@code content}, donde {@code nameFile} es el nombre del archivo, {@code title} es el titulo del mismo 
 * y {@code content} el contenido de este.
 * 
 * @author Francisco Casales (codecasales)
 * @version 1.0
 * @since Enero 2019
 * */

public class Report {
	
	private String nameFile;
	private String title;
	private String content;
	private String extension;
	
	/**
	 * Metodo que obtiene el nombre del archivo a generar
	 * 
	 * @return nameFile es un objeto {@code String} con el nombre del archivo sin extencion.
	 * */
	public String getNameFile() {
		return nameFile;
	}
	/**
	 * Metodo que establece el nombre del archivo sin extencion
	 * 
	 * @param nameFile es un objeto de tipo {@code String} que contiene el nombre del archivo sin extencion.
	 * */
	public void setNameFile(String nameFile) {
		this.nameFile = nameFile;
	}
	/**
	 * Metodo que obtiene el titulo del archivo.
	 * 
	 * @return title es un objeto {@code String} con el titulo del archivo.
	 * */
	public String getTitle() {
		return title;
	}
	/**
	 * Metodo que establece el titulo del archivo sin extencion
	 * 
	 * @param title es un objeto de tipo {@code String} que contiene el titulo del archivo.
	 * */
	public void setTitle(String title) {
		this.title = title;
	}
	/**
	 * Metodo que obtiene el contenido del archivo a generar
	 * 
	 * @return content es un objeto {@code String} con el contenido del archivo sin incluir el titulo.
	 * */
	public String getContent() {
		return content;
	}
	/**
	 * Metodo que establece el contenido del archivo sin extencion
	 * 
	 * @param content es un objeto de tipo {@code String} que tiene el contenido del archivo sin titulo.
	 * */
	public void setContent(String content) {
		this.content = content;
	}
	/**
	 * <h1>Metodo makeReport</h1>
	 * Metodo que se encarga de generar los archivos .txt utilizando los datos establecidos por los setters
	 * <br>
	 * Hace una comprobacion, si {@code nameFile}, {@code title} o {@code content} son nulos no genera el archivo
	 * y le pide al usuario proporcionar los datos necesarios.
	 * */
	public void makeReport() {
		if ( (getNameFile() != null) && (getTitle() != null) && (getContent() != null) ) {
			//Crear el archivo
			try {
				
				File file = new File(getNameFile()+"."+getExtension());
				FileOutputStream fos = new FileOutputStream(file);
				OutputStreamWriter osw = new OutputStreamWriter(fos);
				BufferedWriter bw = new BufferedWriter(osw);
				bw.write(getContent());
				bw.close();
				
			} catch (IOException e) {
				// TODO Auto-generated catch block
				e.printStackTrace();
			}
			 
		} else {
			System.out.println("Ingresa los datos del archivo");
		}
	}
	/**
	 * Metodo que obtiene la extension del archivo a generar
	 * 
	 * @return extension es un objeto {@code String} con la extension del archivo 
	 * sin incluir el nombre del archivo.
	 * */
	public String getExtension() {
		return extension;
	}
	/**
	 * Metodo que establece la extension del archivo
	 * 
	 * @param extension es un objeto de tipo {@code String} que contiene la extension del archivo 
	 * sin incluir el nombre del archivo.
	 * */
	public void setExtension(String extension) {
		this.extension = extension;
	}

}

Ricardo Betancourt

Hace 7 años

Esta genial felicidades

Comentarios (90)90 comentarios

Johan Charris

/**
 * Libreria que permite generar reportes a traves de archivos en cualquier formato 
 * utilizando el Método {@code makeReport}
 * @author Johan
 * @since 2018
 * @version 1.1
 */
public class Report {
    private String nameFile;
    private String title;
    private String content;
    private String extension;

    public String getNameFile() {
        return nameFile;
    }

    public String getExtension() {
        return extension;
    }
}

Jose David Garzon

Hace 6 años

/**

<h1> Repot</h1>

*Report *<p> *Esta es la clase genera reportes en la extension deseada,

Este tiene como parametros obligotorios los siguientes atributos
@param Content {@code String}
@param Extension {@code String}
@param NameFile {@code String} *@param Title {@code String}

*@author david *@version 1.1 *@since 2020

public class Report {

Gilberto A. Guerrero Caballero

/** <b>Report</b>: es una clase publica que permite la generación de un archivo plano (txt), la cual se puede utilizar

en cualquier proyecto que requiera por ejemplo, generación de logs o de tramas diversas.
@author gilberto.guerrero
@version 1.1
@since 2020
*/

Angelica Leung

<h1>Report</h1>
Report es una clase que nos permite generar un archivo de reporte con un contenido, nombre y extensión determinado.
<p>
@author angelica
@version 1.1
@since 2020
*/

Danner Adib Uribe

![](

Curso 2Innovateit

bien genial

Camilo Guevara

Francisco Javier Suarez Verdugo

Listo, acá lo comparto:

/**
 * <h1>Report</h1>
 * Report es una herramienta que nos ayuda a generar un archivo con los datos
 * que se le brindan y además con la extensión que se le indica
 *
 *
 * @author anncode
 * @version 1.1
 * @since 20018
 */
```0

Masrtin Gutierrez

/**
 *	<h1>Report</h1> 
 *	<p>Esta clase se encarga de la emisión de reportes</p>
 *  @author anncode
 *  @author mgutierrez
 *  @since 2020
 *  @version 1.1.0
 * */

public class Report {```

/**
	 * <h2>makeReport<h2>
	 * <p>
	 * Este metodo consiste en crear un reporte con la información que ha sido seteada en el objeto de tipo Report,
	 * crea un archivo, con las especificaciones dadas y guarda en disco el archivo de reporte generado.
	 * @author anncode
	 * @author mgutierrez
	 * @since 2020
	 * @version 1.1.0
	 * 
	 * */
	public void makeReport() {```

Carlos Naveda

Hace 10 meses

Holas, Usé un proyecto anterior que tenía terminado de el "Curso de Java"

Coloqué comentarios respectivos para algunas clases y métodos, generé con el siguiente comando la documentación.

Comando:

Salen warnings, porque javadoc espera que todos los métodos tengan sus comentarios para tener una documentación completa, pero para el ejercicio solo apliqué a algunos.

Packages

Clase Main.java

Clase Interfaz Promotional.java

Clase Movie.java

Clase Documentary.java

Pablo Villegas Palacio

Hace un año

* Librería Report: utilidades para generar reportes (texto/CSV/…),

* escribirlos a disco y reutilizar plantillas.

* <p>Incluye clases para:

* <ul>

* <li>{@link com.anncode.report.Report}: modelo inmutable de un reporte.</li>

* <li>{@link com.anncode.report.ReportWriter}: escritura a archivos.</li>

* <li>{@link com.anncode.report.ReportBuilder}: construcción fluida.</li>

* </ul>

* @author TuNombre

* @version 1.0

* @since 1.0

package com.anncode.report;

Jesús Alejandro Marrón Legorreta

Daniel Eduardo Espitia Corredor

/**
	 * <h1> Report</h1>
	 * La clase report es utilizada para generar reportes de las peliculas,
	 * capitulos de series y libros que se han visualizado.
	 * <p>
	 * Por ultimo, permite guardar un archivo con la información de los reportes que se hayan
	 * generado.
	 * 
	 * @author Daniel Espitia
	 * @version 1.0
	 * @since 2018
	 * 
	 * */

Yossijaki Jorge Astilleros Chávez

¿Cómo puedo publicar mis capturas?

Muchas gracias juandc 😄 sos un crack

Luis David López Berber

Excelente aporte

Alessandro Morales

 /**
 * <h1>Reporte</h1>
 * esta clase es una libreria
 * <p>
 * Nos ayuda a poder generar reportes con  
 * extension<strong>.txt</strong> utilizando
 * el metodo {@code hacerReporte()}
 * @author   Alessandro
 * @version  1.0
 * @since    2018
 * */

Jhon Martinez

/**
 *<h1> Report</h1>
 * La clase report genera un archivo con los parametros enviados al método {@code makeReport}
 *<p>
 * Para la generación del archivo se validan inicialmente los parametros recibidos.
 *<p>
 *@param {@code nameFile} Parametro del nombre del archivo del reporte.
 *@param {@code content} Parametro del contenido del reporte
 *@param {@code title} Parametro del titulo del reporte
 *@param {@code extension} Parametro obligatorio del tipo de archivo a crear
 *@author Jhon Martinez
 *@version 1.0
 *@since 2018
 *
 **/

movigostudio movigostudio

<h1>Report></h1>
La clase report nos ayuda a generar reportes a través del método {@code makeReport}
@author josueSS
@version 1.1
@since 2018
*/

Documentación de librería Report en Java SE

Progreso del curso

Introducción al Curso

Clases avanzadas

JavaDocs

Clases Anidadas

Interfaces Avanzadas

Colecciones Avanzadas

Excepciones

JDBC

Lambdas

Fin del Curso