问题标签 [haddock]

我正在用 Haddock 编写一些文档，我需要在其中放置一个包含一些值的多列表。我怎么能用黑线鳕做呢？我找不到有关它的信息。嵌入一​​些 html 作为替代看起来也不可能。

我正在为 Haddock 开发一个新主题，并想在一些实际项目中尝试它。如何配置堆栈以使用我的黑线鳕可执行文件？我在 stack.yaml 中看不到任何配置选项。我也尝试将新的黑线鳕可执行文件放入我的 PATH 中，但这没有帮助。

我有两个非常相似的功能，并且都需要完全相同的文档。黑线鳕有没有办法避免评论重复？

我在 Haddock 文档中找不到此功能的描述，但我想有办法做到这一点。

例如，在 Javadoc 中有{@inheritDoc}和@see SomeClass#someMethod()。黑线鳕呢？

浏览各种包的黑线鳕时，我经常看到类似这样的实例文​​档（Control.Category）：

或者这个（Control.Monad.Trans.Identity）：

亲切的签名到底是什么意思？它没有出现在源代码中，但我已经注意到它似乎出现在使用PolyKinds扩展的模块中。我怀疑它可能就像一个 TypeApplication 但有一种。因此，例如最后一个示例意味着IdentityT如果它的第一个参数有 kind ，它就是一个 monad 转换器*。

所以我的问题是：

• 我的解释是否正确？善意的签名到底指的是什么？
• 首先Category，我怎么知道这k是一种类型而不是类型？还是我只需要知道 arity 的数量Category？
• 与此语法类似的源代码是什么？

我不是要求对种类进行解释。

I have not been able to generate documentaion for haskell using haddock.

So far I have not found any useful examples. The documentation has a lot of options and also I am not sure about the comment syntax so that documentation is correctly generated.

I know that inside ghci I can call :bro for loaded files and it lists types and functions, I wish these functions could be documented with haddock even without comments. I don't know if this is possible.

我正在使用的项目在 Stackage 上没有文档（它们已经过时了）。这是 0.3 版的原始版本

https://hackage.haskell.org/package/reflex-dom-0.3/docs/Reflex-Dom-Widget-Basic.html

有人告诉我我可以用黑线鳕生成文档。我的电脑上有源代码（使用git clone）版本 0.4

黑线鳕网页太先进了。

对于初学者，一旦进入我的目录，如何生成文档？

感谢我取得进展的答案之一，但这里有一条错误消息：

我正在尝试使用黑线鳕为 github 库生成文档。这是我输入的代码：

然后我查看了我的源代码Xhr.hs第 154 行的相关部分：

我不知道#if，#else并且#endif是 Haskell 的一部分，但我能猜到意思。根据版本，代码应该导入Aeson.Text或Aeson.Encode。以防万一，我查了一下版本：

这足以给黑线鳕带来困难。信息页面被发送到一个名为的文件夹docs，其中包含一些等待填充Reflex.Dom库详细信息的空 html 文件。

基础黑线鳕中有一些模块没有文档链接。例如，GHC/Show.hs有黑线鳕注释，但GHC.Show在 Hackage 上没有该模块的文档。为什么不？这是一个错误吗？

事实证明，Haddock 不会为类型类方法呈现每个参数的文档：

这会给我维护的库的用户带来某些问题，因为在我的案例中，这些方法的签名很长。我一直将源中的描述格式化为这样（当然适用于普通函数），但事实证明 Haddock 没有显示它们（也没有抱怨它们）。

有没有办法用 Haddock 显示每个参数的文档？也许一些解决方法？

来自Stephen Diehl 的“学习 Haskell 时我希望知道的内容”页面的Haddock 部分：

haddock 选项也可以在源代码中使用编译指示指定，无论是在模块级别还是在项目级别。

给出了模块级别的编译指示示例：

{-# OPTIONS_HADDOCK show-extensions, ignore-exports #-}

但是可以将这些选项放置在哪个文件的哪个部分（使用时stack）以应用于整个项目（或者更确切地说，“包”）？