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 메서드 또는 생성자의 value 매개 변수 x 에 대한 세부 정보입니다.
@tparam x detail 메서드 또는 생성자의 type 매개 변수 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