{ - ＃OPTIONS_HADDOCK hide＃ - }是否對非導出的模塊有影響？

Question

假設我有一個使用Cabal打包並構建的庫，並且某些模塊Internal不在我的cabal文件的Exposed-modules中。是否然後進行任何區別，如果我在Internal.hs頂部指定編譯

{-# OPTIONS_HADDOCK hide #-} 

，或者是根據黑線鱈已經自動隱藏？

如果確實有區別，它有什麼作用？

Answer 1

如果使用--internal標誌創建包的分數爲cabal haddock，那麼確實會有所幫助。

$ cabal help haddock 
Usage: cabal haddock [FLAGS] 

Flags for haddock: 
-h --help     Show this help text 
-v --verbose[=n]   Control verbosity (n is 0--3, default verbosity 
          level is 1) 
    <snip> 
    --executables   Run haddock for Executables targets 
    --internal    Run haddock for internal modules and include all 
          symbols 
    <snip> 

如果沒有--internal標誌被創建的黑線鱈，該hide模塊屬性沒有影響：該模塊沒有創建文檔反正。

如果--internal給出，則文檔是針對非暴露模塊除了那些指定hide屬性創建。

換句話說，如果hide未設置和任--internal指定或模塊導出生成的文檔。

爲cabal haddock採用--internal可以與cabal install --haddock-internal指定，或者手動調用cabal haddock時，或與runhaskell ./Setup.hs ...接口。

大多數人只是運行cabal install與默認選項，所以只有少數人會觀察到的差異。