gpt4 book ai didi

haskell - 是否可以使用黑线鳕隐藏特定功能以使其不出现在文档中?

转载 作者:行者123 更新时间:2023-12-04 04:12:08 24 4
gpt4 key购买 nike

我使用黑线鳕,不希望所有导出的函数都显示在文档中。是否可以隐藏特定功能?
我在 http://www.haskell.org/haddock/doc/html/module-attributes.html 找到了 prune 属性,但这不是我想要的,因为某些要导出的函数没有文档注释。

最佳答案

假设您当前的模块是 Foo.Bar ,一种解决方案是将其分解为 Foo.BarFoo.Bar.Internal .您可以将所有与您不想导出的函数相关的定义——甚至可能是所有定义——移动到 Foo.Bar.Internal 中。 .然后,在 Foo.Bar ,您将只重新导出您希望世界看到的定义。

这种方法有几个优点。它可以让你导出你需要的所有东西,同时仍然给用户一个明确的信号,表明某些东西不应该被使用。它还可以让您在 Internal 中记录您的特殊功能。模块,这将是有用的(如果只是为了你 future 的自己:P)。

你不能直接导出 Foo.Bar.Internal在您的 .cabal文件,将其隐藏在世界之外。但是,这不一定是最好的方法;查看 How, why and when to use the ".Internal" modules pattern? 的答案, 特别是 luqui's .

关于haskell - 是否可以使用黑线鳕隐藏特定功能以使其不出现在文档中?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/16887023/

24 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com