Scala Language
Scaladoc

Android apache-spark Haskell Language Java Language MongoDB MySQL postgresql Python Language Regular Expressions SQL
Sök…


Syntax

  • Gå över metoder, fält, klasser eller paket.
  • Börjar med /**
  • Varje rad har en start * -behandling med kommentarerna
  • Slutar med */

parametrar

Parameter detaljer
Klassspecifik _
@constructor detail Förklarar klassens huvudkonstruktör
Metodspecifik _
@return detail Detaljer om vad som returneras på metoden.
Metod, konstruktör och / eller klasstaggar _
@param x detail Detaljer om värdeparametern x på en metod eller konstruktör.
@tparam x detail Detaljer om typparametern x på en metod eller konstruktör.
@throws detail Vilka undantag kan kastas.
Användande _
@see detail Hänvisar till andra informationskällor.
@note detail Lägger till en anteckning för för- eller postvillkor eller andra anmärkningsvärda begränsningar eller förväntningar.
@example detail Tillhandahåller exempelkod eller relaterad exempeldokumentation.
@usecase detail Ger en förenklad metoddefinition för när den fullständiga metoddefinitionen är för komplex eller bullrig.
Övrig _
@author detail Ger information om författaren till följande.
@version detail Tillhandahåller den version som denna del tillhör.
@deprecated detail Markerar följande enhet som avskrivet.

Enkel Scaladoc till metod

/**
  * 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
Licensierat under CC BY-SA 3.0
Inte anslutet till Stack Overflow