Reference manual for FPDoc Document version 3.2.2

• 语言: 英语
• 格式: .pdf
• 来源: downloads.freepascal.org

摘要

文档介绍了FPDOC，一个用于生成Pascal单元文档的工具。它结合Pascal源文件和XML描述文件，生成带有交叉引用的文档，支持HTML、LaTeX、CHM、RTF、TXT和Man等多种输出格式。FPDOC不依赖于代码中的注释，保持代码清洁，适合大型项目文档管理。文档详细说明了安装、使用方法及各种命令行选项。

AI总结

### FPDoc 参考手册总结

#### 1. 简介
- **FPDoc** 是一个用于生成 Pascal 单元文档的免费工具，结合源文件和 XML 描述文件，生成带交叉引用的文档。
- **特点**：
- 不需要在代码中添加大量注释，保持代码清晰。
- 支持按包（package）生成文档，适合大型项目。
- 支持多种输出格式，包括 HTML、LaTeX、RTF、CHM、TXT 等。
- 文档可以引用其他使用 FPDoc 生成的文档集。

#### 2. 安装与使用
- **安装要求**：
- Free Pascal 编译器源代码。
- FCL（Free Component Library）单元。
- `fpcmake` 和 `makeskel` 工具。
- **编译步骤**：
1. 下载 FPDoc 源代码和 Free Pascal 编译器。
2. 配置 `Makefile.ftp` 中的 `fpcdir` 指向 Free Pascal 源代码目录。
3. 运行 `fpcmake` 生成 Makefile，再运行 `make` 生成可执行文件。

#### 3. 输出格式
- **HTML**：
- 生成带有 JavaScript 和样式表的 HTML 文件。
- 支持通过 `--charset` 指定字符集，默认为 `iso-8859-1`。
- **XHTML**：
- 与 HTML 类似，但使用更严格的语法。
- **LaTeX**：
- 生成 LaTeX 文件，适合生成 PDF 文档。
- 每个包生成一个文件，每个单元生成一章，包含常量、类型、变量、函数和类等内容。
- **RTF/CHM**：
- 通过 `latex2rtf` 工具将 LaTeX 文件转换为 RTF 或 CHM 格式。
- **TXT**：
- 生成简单的文本文件，结构类似 LaTeX 输出，但无交叉引用。

#### 4. 命令行选项
- **常用选项**：
- `--auto-index`：生成索引文件（仅适用于 CHM 后端）。
- `--auto-toc`：生成目录文件（仅适用于 CHM 后端）。
- `--charset`：指定 HTML 输出的字符集。
- `--hide-protected`：隐藏受保护的字段和方法。
- `--html-search`：指定搜索 URL（仅适用于 HTML 输出）。
- `--image-dir`：指定图片目录。
- `--import`：导入其他包的目录文件，生成跨文档集的引用。
- `--format`：指定输出格式（如 `latex`、`html`、`chm` 等）。

#### 5. 文档结构
- **LaTeX 输出**：
- 按包生成文件，每个单元生成一章。
- 包括常量、类型、变量、函数/过程、类等内容。
- 函数/过程分为小节，包含 synopsis、声明、参数描述、错误和引用。
- **CHM 输出**：
- 继承 HTML 后端，生成压缩的 CHM 文件。
- 支持自动索引和目录生成。
- **TXT 输出**：
- 生成结构化的文本文件，无交叉引用。

#### 6. 获取更多信息
- 官方网站：[http://www.freepascal.org](http://www.freepascal.org)
- 联系方式：[[e-mail]](mailto:[e-mail])