Looking for scala Keywords? Try Ask4Keywords

Scala LanguageScaladoc


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.

Scaladoc Verwandte Beispiele