Scala Language
Scaladok

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


Składnia

  • Wykracza poza metody, pola, klasy lub pakiety.
  • Zaczyna się od /**
  • Każda linia ma początkową * z komentarzami
  • Kończy się na */

Parametry

Parametr Detale
Specyficzne dla klasy _
@constructor detail Wyjaśnia głównego konstruktora klasy
Specyficzne dla metody _
@return detail Szczegóły na temat tego, co jest zwracane w metodzie.
Tagi metod, konstruktorów i / lub klas _
@param x detail Szczegóły dotyczące parametru wartości x w metodzie lub konstruktorze.
@tparam x detail Szczegóły dotyczące parametru typu x w metodzie lub konstruktorze.
@throws detail Jakie wyjątki mogą zostać zgłoszone.
Stosowanie _
@see detail Odwołuje się do innych źródeł informacji.
@note detail Dodaje notatkę dotyczącą warunków przed lub po lub innych istotnych ograniczeń lub oczekiwań.
@example detail Zawiera przykładowy kod lub powiązaną przykładową dokumentację.
@usecase detail Zapewnia uproszczoną definicję metody, gdy pełna definicja metody jest zbyt złożona lub zaszumiona.
Inny _
@author detail Zawiera informacje o autorze następujących elementów.
@version detail Udostępnia wersję, do której należy ta część.
@deprecated detail Oznacza następującą jednostkę jako przestarzałą.

Prosty Scaladoc do metody

/**
  * 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
Licencjonowany na podstawie CC BY-SA 3.0
Nie związany z Stack Overflow