javaDoc Cheat Sheet

A Programming › Java cheat sheet in English and español (Spanish) by Maybe_Me

Etiquetas de documentación de API

2,395 views 512 downloads 24 Feb 2025 History

Etiquetas Globales

@author
Autor del elemento / Element author
@depre­­cated
Elemento obsoleto / Deprecated element
@docRoot
Directorio raíz de docume­ntación / Root directory for generated docume­ntation
@exception @throws
Excepción de un elemento / Element exception
{@link #methode nom}
Link a un método / Method link
@param
Parámetro de un elemento / Element parameter
@return
Desccr­ipción del valor de retorno de un método / Descri­ption for a return value of a method
@see
Docume­ntación adicional / Additional docume­ntation
@since
Versión original de inclusión del elemento / Version of in
@version
Versión de un elemento / Element version

Etiquetas Secund­arias

{@code}
Inclusión de código en la docume­ntación / Code included in docume­ntation
{@inhe­­ri­tDoc}
Herencia de Javadoc de la superclase o método sobres­crito / Javadoc inheri­tance from the superclass or overridden method
{@literal}
Texto sin interp­ret­ación HTML / Uninin­ter­preted text
@serial
Documenta la serial­ización / Serial­ization docume­ntation
{@value}
Valor de un campo estático / Static field value

Etiquetas de restri­cción

Global
@see, @since, @depre­­cated, {@link}, {@link­­pl­ain}, {@docroot}
Overview
@see, @since, @author, @version, {@link}, {@link­­pl­ain}, {@docRoot}
Package
@see, @since, @serial, @author, @version, {@link}, {@link­­pl­ain}, {@docRoot}
Clases e interfaces / Classes & interfaces
@see, @since, @depre­­cated, @serial, @author, @version, {@link}, {@link­­pl­ain}, {@docRoot}
Constr­uctores y métodos / Constr­uctors & methods
@see, @since, @depre­­cated, @param, @return, @throws, @excep­­tion, @seria­­lData, {@link}, {@link­­pl­ain}, {@inhe­­ri­t­Doc}, {@docRoot}
Campos / Fields
@see, @since, @depre­­cated, @serial, @seria­­lF­ield, {@link}, {@link­­pl­ain}, {@docR­­oot}, {@value}

Comments

No comments yet.

Cheatography n. The art of mapping complex subjects into clear, instantly navigable reference guides.