Haddock 是 Haskell 生态的文档标记:附着在函数上的 -- 注释块,渲染成每个 Hackage 包自带的 API 文档。
典型用途: 把 Haskell 文档迁入 Markdown 或 HTML 手册时,转换 Haddock 注释。
关于 Haddock 格式
Haddock 是 Haskell 解释自己的方式:-- 注释块里的文档,用 '标识符链接'、@等宽@ 和 /斜体/ 标记,编译成 Hackage 上每个包都发布的 API 参考页。标记活在源码里,但格式自成一们小语言。
从源码注释里转出后,Haddock 文本变成普通结构化散文:Pandoc 把标题、代码块和标识符链接映射到 Markdown 或 HTML,API 知识得以进入手册、wiki 或静态站点生成器,无需重新打字。
优势
- ✓ 文档与所描述的代码同处一地
- ✓ 跨 API 的标识符感知链接
- ✓ 整个 Haskell 生态的标准
局限
- ✗ 只在 Haskell 项目里有意义
- ✗ 语法小,Haddock 之外输出器少
- ✗ 嵌在注释里——需先提取
- 数据结构
- 注释标记(--、'links'、@mono@)
- 类型与校验
- UTF-8 文本
- 兼容性
- Haskell、Hackage、Pandoc
- 最适合
- Haskell API 文档
将 Haddock 转换为…
6 个直接转换方向,另有 1 个工作流,按目标格式 A–Z 排序;🔥 为热门目标。
Haddock 转 HTM Hot Haddock 转 HTML Hot Haddock 转 Markdown Haddock 转 MD Hot Haddock 转 MHT Haddock 转 XHTML
跨引擎工作流
常见问题
Haddock 文件是什么?
Haddock 是 Haskell 生态的文档标记:附着在函数上的 -- 注释块,渲染成每个 Hackage 包自带的 API 文档。
如何在线转换 Haddock 文件?
在下方「将 Haddock 转换为」列表中选择目标格式,拖入文件点击转换即可。所有处理都在你的浏览器内完成——无需安装、无需上传、无水印、不限次数。
在这里转换 Haddock 文件安全吗?
安全。全部转换由你自己的设备在浏览器内完成,文件永远不会被上传到服务器——断网状态下页面依然可用。
Haddock 可以转换成哪些格式?
本页列出全部 7 个方向,覆盖文档、图像、音频、视频、表格与压缩包等类别;每个方向都是独立的免费转换器页面。