Scala Language
Scaladoc

Android apache-spark Haskell Language Java Language MongoDB MySQL postgresql Python Language Regular Expressions SQL
Buscar..


Sintaxis

  • Va por encima de los métodos, campos, clases o paquetes.
  • Comienza con /**
  • Cada línea tiene un inicio * procesando con los comentarios.
  • Termina con */

Parámetros

Parámetro Detalles
Clase especifica _
@constructor detail Explica el constructor principal de la clase.
Método específico _
@return detail Detalles sobre lo que se devuelve en el método.
Método, constructor y / o etiquetas de clase. _
@param x detail Detalles sobre el parámetro de valor x en un método o constructor.
@tparam x detail Detalles sobre el parámetro de tipo x en un método o constructor.
@throws detail Qué excepciones se pueden lanzar.
Uso _
@see detail Referencias otras fuentes de información.
@note detail Agrega una nota para las condiciones previas o posteriores, o cualquier otra restricción o expectativa notable.
@example detail Proporciona código de ejemplo o documentación de ejemplo relacionada.
@usecase detail Proporciona una definición de método simplificada para cuando la definición de método completa es demasiado compleja o ruidosa.
Otro _
@author detail Proporciona información sobre el autor de los siguientes.
@version detail Proporciona la versión a la que pertenece esta parte.
@deprecated detail Marca la siguiente entidad como desaprobada.

Scaladoc simple al método

/**
  * Explain briefly what method does here
  * @param x Explain briefly what should be x and how this affects the method.
  * @param y Explain briefly what should be y and how this affects the method.
  * @return Explain what is returned from execution.
  */
def method(x: Int, y: String): Option[Double] = {
  // Method content
}


Modified text is an extract of the original Stack Overflow Documentation
Licenciado bajo CC BY-SA 3.0
No afiliado a Stack Overflow