가져온 엔티티에 대한 대용량 코멘트

Question

내보낼 모듈의 엔티티에 선언 대신 엔티티에 추가 할 수 있습니까?

12 가지 유형을 선언하는 숨겨진 모듈이 있고 최종 사용자가 보게 될 부분 만 내보내는 또 다른 모듈이 있습니다. 문서를 숨겨진 모듈이 아닌 노출 된 모듈에 넣는 것이 논리적 일 것입니다. 하지만 어떻게해야할지 모르겠다. ...

Answer 1

아니오, 불가능합니다. 함수 인자 별, 타입 PARAM 문서를 가질 수 있습니다, 당신은 수 있다면 문서 일치 할 것 :

1. 는
2. 이 한 버전이 다른
3. 가 불일치를 소개 우선 다른 위치에 다른 버전을 쓰기 인수 문서 : 함수의 주요 문서 문자열을 무시하면 어떻게됩니까? 인수 doc 문자열을 제거해야합니까?

다음 파일 :

module Bla 
     (-- * Fooishness 

     -- | This is 'foo'. It is not 'bar'. 
     foo 
     , -- * Barishness 

     -- | This is 'bar'. It is sometimes a little 'foo'. 
     bar 
     ) where 

-- | The actual foo documentation 
foo :: a --^The a 
    -> b --^The b 
    -> c 
foo = undefined 

-- | The actual bar documentation 
bar :: a 
bar = undefined 

... 수율이 문서 :

당신은 당신이 가지 기능 문서 문자열을 에뮬레이트하는 섹션의 주석을 사용할 수 있습니다 볼 수 있듯이 그러나 형식 서명에 따라 함수 문서 주석을 사용하는 경우에만 설명서가 올바르게 생성됩니다.

Answer 2

음, 생각해 보니 노출 된 모듈에 newtype을 쓸 수있었습니다. 런타임 오버 헤드가 없으므로 코드가 좀 더 지저분 해집니다. ...