Scala Language
Scaladoc

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


Syntaxis

  • Gaat boven methoden, velden, klassen of pakketten.
  • Begint met /**
  • Elke regel heeft een startprocedure * met de opmerkingen
  • Eindigt met */

parameters

Parameter Details
Klasse specifiek _
@constructor detail Verklaart de hoofdconstructeur van de klasse
Methode specifiek _
@return detail Details over wat er op de methode wordt geretourneerd.
Tags voor methode, constructor en / of klasse _
@param x detail Details over de waardeparameter x op een methode of constructor.
@tparam x detail Details over het type parameter x op een methode of constructor.
@throws detail Welke uitzonderingen kunnen worden gegooid.
Gebruik _
@see detail Verwijzingen naar andere informatiebronnen.
@note detail Voegt een notitie toe voor voor- of na-voorwaarden, of andere opvallende beperkingen of verwachtingen.
@example detail Biedt voorbeeldcode of gerelateerde voorbeelddocumentatie.
@usecase detail Biedt een vereenvoudigde methode-definitie voor wanneer de volledige methode-definitie te complex of te luid is.
anders _
@author detail Biedt informatie over de auteur van het volgende.
@version detail Biedt de versie waartoe dit gedeelte behoort.
@deprecated detail Markeert de volgende entiteit als verouderd.

Eenvoudige Scaladoc naar methode

/**
  * 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
Licentie onder CC BY-SA 3.0
Niet aangesloten bij Stack Overflow