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

Question

在为用C编写的某些库编写Haskell绑定时，必须做的是以haddock格式编写文档。但是，由于通常绑定只是简单的，所以该文档将只是原始libs文档的格式。

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

Answer 1

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

如果绑定确实是简单的，实际上IO中的所有内容，与C库相同的名称，等等。还有一个非常懒惰的选择：提供指向C文档的链接并引用它。

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

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