首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

'stack haddock‘把它生成的文档放在哪里?

stack haddock是一个用于生成Haskell项目文档的命令。它会根据项目中的代码注释和类型信息生成文档,并将其保存为HTML格式。

生成的文档默认会放在项目的根目录下的.stack-work文件夹中的doc目录中。具体路径为:项目根目录/.stack-work/doc/index.html

stack haddock生成的文档可以通过浏览器打开,提供了对项目代码和API的详细说明和文档化。这对于项目的维护者和其他开发人员来说非常有用,可以帮助他们更好地理解和使用项目中的代码。

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

  • JDK8之后-JVM运行时数据区域

    首先弄清几个概念: 1.方法区(method area)只是JVM规范中定义的一个概念,用于存储类信息、常量池、静态变量、JIT编译后的代码等数据,具体放在哪里,不同的实现可以放在不同的地方。永久代是HotSpot虚拟机特有的概念,是对方法区的实现,别的JVM没有永久代的概念。(虽然去除了永久代,但是方法区作为概念上的区域仍然存在) 2.在JDK8中,JDK8的HotSpot VM已经是以前的HotSpot VM与JRockit VM的合并版,也就是传说中的“HotRockit”,只是产品里名字还是叫HotSpot VM。所以对于说JDK8去除永久代换成元空间的说法,就是默指的合并后的HotSpot虚拟机。 3.为什么要将永久代去除呢? 一方面是节省空间,避免了常见的永久内存错误:java.lang.OutOfMemoryError: PermGen问题。另一方面是为了整合JRockit,因为JRockit没有永代区这样类似的空间。 其实,从jdk7开始,就开始了永久代的转移工作,将譬如符号引用(Symbols)转移到了native heap;字面量(interned strings)转移到了java heap;等。但是指导JDK8永久代才被元空间替代。 4.元空间又是什么呢?以前存储在永久代里面的数据现在存在了哪里? 元空间是一块与堆不相连的本地内存。原本存在永久代的数据,一部分移到了java堆里面,一部分移到了本地内存里面(即元空间)(文档中原句:Move part of the contents of the permanent generation in Hotspot to the Java heap and the remainder to native memory.) 。永久代中原来存储的字符串常量(池)、符号引用(这两个在jdk7普遍就已经将其放在堆上了)和类的静态变量现在存储在java堆中,其余的数据作为元数据存储在元空间中。 5.什么是元数据呢? 元数据是数据的数据或者叫做用来描述数据的数据或者叫做信息的信息。(比如原本方法区存储的类信息、即时编译器编译后的代码等),也可以把元数据简单的理解成,最小的数据单位。元数据可以为数据说明其元素或属性(名称、大小、数据类型、等),或其结构(长度、字段、数据列),或其相关数据(位于何处、如何联系、拥有者)。 6.元空间详细:http://blog.csdn.net/lk7688535/article/details/51767460

    04

    Redis作者谈如何编写系统软件的代码注释

    顶顶大名的Redis作者谈如何在Redis这样系统软件上进行代码文档注释,以下是九种注释类型的大意说明: 很长一段时间以来,我一直想在YouTube上发布一段“如何对系统软件文档注释”的新视频,讨论如何进行代码注释,然而,经过一番思考后,我意识到这个主题更适合博客文章。在这篇文章中,我分析了Redis的文档注释,试图对它们进行分类。在此过程中,我试图说明为什么编写注释对于生成良好的代码是至关重要,从长远来看,这些代码是可维护的,并且在修改和调试期间可由其他人和作者自己理解。 并不是每个人都这么想,许多人认为,如果代码足够扎实,代码具有自明性,无需文档注释了。这个想法前提是,需要一切都设计得很完美,代码本身会有文档注释的作用,因此再加上代码注释是多余的。 我不同意这个观点有两个主要原因: 1. 许多注释并不是解释代码的作用,而是解释*为什么*代码执行这个操作,或者为什么它正在做一些清晰的事情,但却不是感觉更自然的事情?注释是解释一些你无法理解的东西。(banq注:根据海德格尔存在主义哲学观点,注释是解释代码的存在意义,如果注释时说明代码作用,那是在说明代码的存在方式,代码的功能作用是代码的存在方式,不是存在意义,存在意义与编写者动机和阅读者的理解有关,与其上下文场景有关) 2.虽然一行一行地记录代码做些什么通常没有用,因为通过阅读代码本身也是可以理解的,编写可读代码的关键目标是减少工作量和细节数量。但是应该考虑其他阅读者在阅读一些代码时他们的思考角度和进入门槛的难易程度。因此,对我而言,文档注释可以成为降低阅读者认知负担的工具。 以下代码片段是上面第二点的一个很好的例子。请注意,此博客文章中的所有代码段都是从Redis源代码中获取的。

    06
    领券