haskell - 为绑定编写文档的正确方法是什么？

Question

在为一些用 C 编写的库编写 Haskell 绑定时，必须做的事情是以黑线鳕格式编写文档。但是由于通常绑定很简单，因此文档将只是原始库文档的重新格式化。

所以我的问题是，是否有一些工具可以帮助解决这个问题？谢谢。

Answer 1

我不知道有什么工具可以做到这一点。由于 C 文档可以采用多种形式，我认为没有任何工具。

如果绑定确实是普通的，基本上所有内容IO，与 C 库相同的名称等。有一个非常懒惰的选择：提供 C 文档的链接并参考它。

更好：如果 C 文档在线，并且每个函数/变量/实体都有自己的链接，请为每个实体提供一个链接。通过这种方式，Haskell 程序员可以像往常一样在 Hackage 中找到您的文档，然后只需单击一下即可找到真正的文档。

当然，理想情况下应该复制 C 文档，以便立即可用。但是，这可能需要大量工作，并且需要注意正确处理版权。