Scala Language
Scaladoc

Android apache-spark Haskell Language Java Language MongoDB MySQL postgresql Python Language Regular Expressions SQL
Поиск…


Синтаксис

  • Выбирает методы, поля, классы или пакеты.
  • Начинается с /**
  • В каждой строке есть начальная * процедура с комментариями
  • Заканчивается на */

параметры

параметр подробности
Специально для класса _
@constructor detail Объясняет главный конструктор класса
Метод специфический _
@return detail Подробности о том, что возвращается методу.
Теги метода, конструктора и / или класса _
@param x detail Сведения о параметре значения x для метода или конструктора.
@tparam x detail Подробная информация о параметре типа x для метода или конструктора.
@throws detail Какие исключения могут быть брошены.
использование _
@see detail Ссылки на другие источники информации.
@note detail Добавляет примечание для условий до или после сообщения или любых других заметных ограничений или ожиданий.
@example detail Предоставляет примерный код или соответствующую документацию по примерам.
@usecase detail Предоставляет упрощенное определение метода, когда полное определение метода слишком сложное или шумное.
Другой _
@author detail Предоставляет информацию об авторе о следующем.
@version detail Предоставляет версию, которой принадлежит эта часть.
@deprecated detail Помечает следующий объект как устаревший.

Простой метод Scaladoc к методу

/**
  * 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
Лицензировано согласно CC BY-SA 3.0
Не связан с Stack Overflow