Scala Language
Scaladoc

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


Syntax

  • Geht über Methoden, Felder, Klassen oder Pakete.
  • Beginnt mit /**
  • Jede Zeile hat einen Startvorgang * mit den Kommentaren
  • Endet mit */

Parameter

Parameter Einzelheiten
Klassenspezifisch _
@constructor detail Erläutert den Hauptkonstruktor der Klasse
Methodenspezifisch _
@return detail Details dazu, was auf der Methode zurückgegeben wird.
Methoden-, Konstruktor- und / oder Klassen-Tags _
@param x detail Details zum Werteparameter x in einer Methode oder einem Konstruktor.
@tparam x detail Details zum Typparameter x einer Methode oder eines Konstruktors.
@throws detail Welche Ausnahmen können geworfen werden.
Verwendungszweck _
@see detail Verweise auf andere Informationsquellen.
@note detail Fügt eine Notiz für Vor- oder Nachbedingungen oder andere wichtige Einschränkungen oder Erwartungen hinzu.
@example detail Bietet Beispielcode oder zugehörige Beispieldokumentation.
@usecase detail Stellt eine vereinfachte Methodendefinition bereit, wenn die vollständige Methodendefinition zu komplex oder zu laut ist.
Andere _
@author detail Bietet Informationen zum Autor der folgenden.
@version detail Stellt die Version bereit, zu der dieser Teil gehört.
@deprecated detail Markiert die folgende Entität als veraltet.

Einfache Scaladoc-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
Lizenziert unter CC BY-SA 3.0
Nicht angeschlossen an Stack Overflow