黑线鳕 - 云端在线

程序：

您的姓名

haddock - 带注释的 Haskell 源代码的文档工具

概要

黑线鳕 [选项] 文件...

商品描述

本手册页简要记录了 黑线鳕 命令。 广泛的文档是
提供各种其他格式，包括 DVI、PostScript 和 HTML； 见下文。

文件 是包含 Haskell 源模块的文件名。 上指定的所有模块
命令行将一起处理。 当一个模块引用另一个模块中的实体时
正在处理的模块，文档将直接链接到该实体。

无法找到的实体，例如，因为它们在一个未被发现的模块中
作为当前批次的一部分处理，不会在生成的超链接
文档。 黑线鳕 将发出警告，列出所有无法识别的标识符
解决。

模块不应相互递归，因为 黑线鳕 不喜欢游泳
界。

配置

这些程序遵循通常的 GNU 命令行语法，长选项以两个开头
破折号（`--'）。 下面是选项的摘要。 有关完整说明，请参阅
其他文档。

-o DIR, --奥迪尔=DIR
放置输出文件的目录

-i 文件, --读取接口=文件
从中读取接口 文件.

-D 文件, --转储接口=文件
转储这些模块的接口 文件.

-l DIR, --lib=DIR
Haddock 的辅助文件的位置

-h, --html
生成 HTML 格式的文档。 将生成几个文件到
当前目录（或指定目录，如果 -o 选项），包括
执行以下操作：

index.html的
文档的顶级页面：列出可用的模块，使用
如果模块是分层的，则缩进来表示层次结构。

黑线鳕.css
生成的 HTML 使用的样式表。 随意修改这个
更改颜色或布局，甚至使用
--css 选项。

模块.html
每个模块的 HTML 页面。

文档索引.html, 文档索引-XX.html
索引，分为两个（函数/构造函数和类型/类，根据
Haskell 命名空间）并进一步按字母顺序拆分。

——胡格尔
Hoogle 的输出

--html-帮助=格式
以 mshelp、mshelp2 或 devhelp 格式生成索引和目录（带有 -h)

--源库=网址
在生成的文档中包含指向源文件的链接，其中 URL 是
可以在其中找到源文件的基本 URL。

-s 网址， --源模块=网址
在生成的文档中包含指向源文件的链接，其中 URL 是
每个模块的源代码链接（使用 %{FILE} 或 %{MODULE} 变量）。

--源实体=网址
在生成的文档中包含指向源文件的链接，其中 URL 是
每个实体的源代码链接（使用 %{FILE}、%{MODULE} 或 %{NAME} 变量）。

--评论基础=网址
内容和索引页面上的评论链接的 URL。

--评论模块=网址
每个模块的评论链接的 URL（使用 %{MODULE} 变量）。

--评论实体=网址
每个实体的评论链接的 URL（使用 %{FILE}、%{MODULE} 或 %{NAME}
变量）。

--css=文件
使用 CSS 文件 而不是随附的默认样式表 黑线鳕 用于 HTML
输出。 它应该指定某些类：有关详细信息，请参阅默认样式表。

-p 文件, --序言=文件
指定包含序言文本的文件。

-t 题目, --标题=题目
使用 题目 作为文档中每个页面的页面标题。 这会
通常是被记录的库的名称。

标题应该是一个普通的字符串（请不要标记！）。

-k 您的姓名, --包=您的姓名
指定包名称（可选）。

-n, --无隐式前奏
不要假设 Prelude 是进口的

-d, -调试
启用额外的调试输出。

-?, - 帮帮我
显示帮助。

-V, - 版
显示版本。

-v, --详细
详细的状态报告。

--使用内容=网址
使用单独生成的 HTML 内容页面。

--gen-内容
从指定的接口生成 HTML 内容。

--使用索引=网址
使用单独生成的 HTML 索引。

--gen-索引
从指定的接口生成 HTML 索引。

--忽略所有出口
表现得好像所有模块都具有 ignore-exports 属性

--隐藏=模块
表现得好像 模块 有隐藏属性。

--使用包=包
正在处理的模块取决于 包.

使用 onworks.net 服务在线使用黑线鳕