haskell - 在惯用的 Haskell 项目中，主模块应该保存在哪里？

Question

根据 Structure of a Haskell project 的维基百科页面, src惯用的 haskell 项目的文件夹如下所示:

src/           -- For keeping the sourcecode
    Main.lhs     -- The main-module
    App/         -- Use hierarchical modules
      ...
      Win32/     -- For system dependent stuff
      Unix/
    cbits/       -- For C code to be linked to the haskell program

问题:

我假设 Main.lhs是程序的主要入口点。我的意思是它包括 main返回 IO (a) 类型值的方法对于某些类型a .是这样吗？

.lhs是什么意思在 Main.lhs 上扩展?为什么不叫它 Main.hs ?

我在 GitHub 上查看了其他一些流行的 Haskell 项目，它们似乎并没有那么密切地遵循这种结构。这真的是组织 Haskell 项目的惯用方式吗？

Answer 1

1.

是的。 The Haskell specification has a paragraph on this topic ，并且您几乎逐字复制了该语言。

2.
.lhs表示它是 literate Haskell file .在常规的 Haskell 注释中，必须将注释标记为特殊，并且代码是“默认”；在识字的 Haskell 中，情况正好相反:代码必须标记为默认值，注释是“默认值”。正如 Knuth 所说，“主要思想是将程序视为与人类的交流，而不是对计算机的一组指令。”

3.

事实上并没有组织 Haskell 项目的方法。我认为有几种粗略的无定形思想流派:

Blob 。将所有内容放入一个目录并拥有Main.hs成为切入点。这对于一次性脚本和小型项目很有用。它使导入变得容易。你只是import Foo和 Foo.hs从目录中包括在内。

与文件夹的 Blob。随着时间的推移，你会意识到这个和那个模块作为子模块属于一起，这些和那些也是如此。您现在可以创建 src/目录并将所有文件放在那里。此时你可能会开始这样组织:

/
 src/
   • Main.hs
   • Types.hs
   Types/
     • Internal.hs
     • Gadgets.hs
     • Geegaws.hs
 • project.cabal
 • README.md

这里我们有一个 Types从 Types.* 重新导出所有内容的模块这样你就可以import Types获取一切，或者，如果您愿意，import Types.Internal或 import Types.Gadgets导入 Types 的子模块点菜。

大图书馆，小可执行文件。如果您使用 Cabal 或 Stack，您可以设置库目标，然后设置依赖于库目标的可执行目标。 Main.hs和可能的支持模块存在于可执行文件中，它们从库中导入代码。这对于测试来说是理想的，因为测试是一个单独的目标，也可以依赖于库。如果您希望您的项目产生额外的可执行目标，您也可以使用它，这代表更大的系统。您的结构可能如下所示:

/
 lib/
   Types/
     • Internal.hs
     • Gadgets.hs
     • Geegaws.hs
   Types.hs
 src/
   • Main.hs
   • Utils.hs
 • project.cabal
 • README.md

两者之间有各种各样的选择。 lib/和 src/然而，命名非常地道。我猜它来自大型 C 系列项目(尤其是 GNU 项目)倾向于命名事物的方式。 cbits/似乎是一个有趣的名称，每个人都集体选择用于包含将与 Haskell 代码进行外部函数接口(interface)的代码的目录。偏离那篇维基文章是可以的，我想这是外卖。

如果您 install Stack ，您可以创建一个目录并运行 stack new . Stack 附带一个默认目录结构(您可以自定义或完全关闭它)。可能有助于比较和对比。