Scala Language
Scaladoc

Android apache-spark Haskell Language Java Language MongoDB MySQL postgresql Python Language Regular Expressions SQL
Recherche…


Syntaxe

  • Va au-dessus des méthodes, des champs, des classes ou des packages.
  • Commence par /**
  • Chaque ligne a un début * procédant avec les commentaires
  • Se termine par */

Paramètres

Paramètre Détails
Classe spécifique _
@constructor detail Explique le constructeur principal de la classe
Méthode spécifique _
@return detail Détails sur ce qui est retourné sur la méthode.
Balises Method, Constructor et / ou Class _
@param x detail Détails sur le paramètre de valeur x sur une méthode ou un constructeur.
@tparam x detail Détails sur le paramètre de type x sur une méthode ou un constructeur.
@throws detail Quelles exceptions peuvent être levées.
Usage _
@see detail Fait référence à d'autres sources d'informations.
@note detail Ajoute une note pour les conditions pré ou post, ou toute autre restriction ou attente notable.
@example detail Fournit un exemple de code ou un exemple de documentation associée.
@usecase detail Fournit une définition de méthode simplifiée lorsque la définition complète de la méthode est trop complexe ou trop bruyante.
Autre _
@author detail Fournit des informations sur l'auteur des éléments suivants.
@version detail Fournit la version à laquelle appartient cette partie.
@deprecated detail Marque l'entité suivante comme étant obsolète.

Scaladoc simple à la méthode

/**
  * 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
Sous licence CC BY-SA 3.0
Non affilié à Stack Overflow