복붙노트

[SCALA] 왜 scaladoc 방법 서명이 잘못입니까?

SCALA

왜 scaladoc 방법 서명이 잘못입니까?

메소드 서명이 잘못 특히 컬렉션 스칼라 API의 장소, 많이 있습니다.

예를 들어, Map.flatMap에 대한 scaladoc 서명 말한다

def flatMap[B](f: (A) ⇒ GenTraversableOnce[B]): Map[B]

그러나 실제 서명은

flatMap[B, That](f: ((A, B)) ⇒ GenTraversableOnce[B])
    (implicit bf: CanBuildFrom[Map[A, B], B, That]): That

scaladoc 서명이 맵 [B]를 포함하기 때문에 이것은 특히 이해되지 않는다, 그러나지도는 두 개의 입력 매개 변수가 아닌 하나입니다.

여기 무슨 일이야? 이건 실수인가?

해결법

  1. ==============================

    1.당신이 생성 된 문서에서 볼 수있는 잘못된 서명은 "사용 사례"라고합니다. 그들은 실제와 유사한 이상화 API를 보여주는하지만 (어떤 사람들을 괴롭히는 보급 암시 CanBuildFrom 매개 변수 등) 지루한 세부 사항을 생략하여 문서를 명확하게 생각하고 있습니다.

    당신이 생성 된 문서에서 볼 수있는 잘못된 서명은 "사용 사례"라고합니다. 그들은 실제와 유사한 이상화 API를 보여주는하지만 (어떤 사람들을 괴롭히는 보급 암시 CanBuildFrom 매개 변수 등) 지루한 세부 사항을 생략하여 문서를 명확하게 생각하고 있습니다.

    사용 사례와 방법의 경우, 다른 섹션을 보여줍니다 그 서명을 확장하기 위해 "전체 서명"그 방법에 대한 세부 정보를 표시하는 방법 이름을 클릭 한 다음 클릭하여 실제 서명을 얻을 수 있습니다.

  2. from https://stackoverflow.com/questions/26132459/why-are-scaladoc-method-signatures-wrong by cc-by-sa and MIT license