Scala Language
scaladoc

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


Sintassi

  • Passa sopra metodi, campi, classi o pacchetti.
  • Inizia con /**
  • Ogni riga ha una procedura * iniziale con i commenti
  • Termina con */

Parametri

Parametro Dettagli
Classe specifica _
@constructor detail Spiega il principale costruttore della classe
Metodo specifico _
@return detail Dettagli su ciò che viene restituito sul metodo.
Metodo, Costruttore e / o Tag di classe _
@param x detail Dettagli sul parametro value x su un metodo o costruttore.
@tparam x detail Dettagli sul parametro type x su un metodo o costruttore.
@throws detail Quali eccezioni possono essere lanciate.
uso _
@see detail Riferimenti ad altre fonti di informazione.
@note detail Aggiunge una nota per le condizioni pre o post, o altre restrizioni o aspettative importanti.
@example detail Fornisce codice di esempio o documentazione di esempio correlata.
@usecase detail Fornisce una definizione di metodo semplificata per quando la definizione del metodo completo è troppo complessa o rumorosa.
Altro _
@author detail Fornisce informazioni sull'autore di quanto segue.
@version detail Fornisce la versione a cui appartiene questa parte.
@deprecated detail Contrassegna la seguente entità come deprecata.

Semplice metodo Scaladoc

/**
  * 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
Autorizzato sotto CC BY-SA 3.0
Non affiliato con Stack Overflow