fpdoc-3.0.0 - 云端在线

程序：

您的姓名

fpdoc - FPC Pascal 单元文档生成器。

概要

文件 --input=输入命令 [--output=输出] [--format=fmt] [--descr=描述文件]
[--package=packagename] [选项]

描述

文件 扫描 Free Pascal 单元源文件并为其生成文档。 这
文档可以是各种格式（目前是 HTML 和 LaTeX）它可以阅读各种
描述文件，其中包含单元中各种符号的描述
文件中。

用法

你可以调用 文件 'input' 和 'package' 作为唯一必需的参数
论据。 它至少应该包含文档所在的单元文件的名称
应该生成和单元所属的包的名称。

附加选项

文件 有几个选项，其中大部分是可选的，大多数情况下将使用默认值。

- 内容
这个选项告诉 文件 生成内容文件。 内容文件包含一个列表
生成的文档文件中所有可能的锚点（标签），并且可以
用于在不同单位的文档中创建交叉链接，使用
- 进口 选项。

--cputarget=值
这个选项告诉 文件 为哪个 CPU 生成文档。 这简直
定义适当的 CPU 宏。

--descr=desc 文件
此选项指定描述文件的名称 描述文件 包含
单位的实际文件。 这个选项可以多次给出，对于
几个描述文件。

--descr-dir=目录
此选项指定带有 XML 描述文件的目录的名称，命名为 DIR
对于多个描述目录，可以多次给出此选项。 这个
选项等效于使用 --descr 指定目录中的所有文件
选项。

--不要修剪
此选项告诉 fpdoc 不要修剪 XML 文件中的空格。 默认情况下，
从输入中修剪空白，这可能会产生不良的副作用
例如 PRE 标签。

--试运行
这个选项告诉 文件 不生成任何输出，而只是解析所有输入。 这个
可以与详细选项一起使用来检查哪些错误保留在
文档，或者仍然缺少什么。

--格式=fmt
指定格式 fmt 将在其中生成文档。 目前，
已知以下格式：

CHM 具有 8.3 符合文件名的 CHM，主要用于 Windows。

数据表 Delphi 兼容的 XML 输出。

HTM 符合 8.3 文件名的 HTML。

HTML 带有长文件名的 HTML。

IPF IPF 输出（OS/2 格式，可与 fpGUI 的 docview 一起使用）。

的xhtml 具有长文件名的 XHTML。

胶乳 LaTex，它使用 Free Pascal 文档使用的 fpc.sty 样式。

男子 手册页输出（unix 手册页，每个标识符一页）。

RTF RTF 输出。

TXT 纯文本输出。

xml结构
结构化 XML。

- 帮帮我 显示命令行选项摘要。

--隐藏保护
默认情况下，文档将包括受保护的描述和列表
类或对象中的字段和方法。 此选项更改此行为； 如果它
指定，不会为这些方法生成文档。 注意
引用这些受保护方法的公共方法或属性将具有
悬空（即不可用）链接。

--html-search=链接
在位置添加 HTML 搜索页面的条目 链接 在标题中
生成的 HTML 页面。 没有提供搜索页面，这应该做
由用户提供。

--import=imp 文件
导入内容文件 输入文件 来自另一个文档集。 这可以用来
解析对其他文档文件中元素的引用；

--输入=cmd
这个选项告诉 文件 应该使用什么输入文件。 论据 CMD 可
只是一个文件名，但也可以是一个带有选项的完整编译器命令行
关注 pascal 源的扫描：定义、包含文件、语法选项、
因为它们会在编译文件时指定给自由的 pascal 编译器。 如果
使用完整的命令，则应将其括在单引号或双引号中，
所以外壳不会把它们分成几部分。 可以指定多个
输入命令； 他们将一一处理，文件将被
为他们中的每一个生成。

--输入目录=目录
这个选项告诉 文件 在名为的目录中添加所有 .pas 和 .pp 文件 CMD as
将文件输入到文档记录器。 这等效于指定文件夹中的所有文件
目录与 - 输入 命令。

--lang=语言
设置输出文件的语言。 这将主要设置用于的字符串
文档文件各个部分的标题（默认情况下它们在
英语）。 目前，有效的选项是

de 德语。

fr 法语。

nl 荷兰人。

--latex-extension=分机
将用于 LaTeX 文件的扩展名设置为 分机 默认是 .tex （和 。
（点）包括）。

--乳胶高亮
打开内部乳胶语法荧光笔。 这还没有实施。 经过
默认情况下，语法高亮是由 fpc 自带的语法包提供的。

--mo-dir=目录
这个选项告诉 文件 在哪里可以找到可用于的翻译文件
国际化 fpdoc 的输出。

--ostarget=值
这个选项告诉 文件 为哪个操作系统生成文档。 这个
只需定义适当的操作系统宏。

--输出=名称
这个选项告诉 文件 应该在哪里生成输出文件。 这个选项如何
解释取决于使用的格式。 对于乳胶， 姓名 被解释
作为 tex 文件的文件名。 对于所有其他格式， 姓名 被解释为
将写入所有文档文件的目录。 该目录将是
如果尚不存在，则创建。 标准 this 等于包名称。

--package=包名
指定包名称。 所有单位都将被记录为 包裹名字 ,
这也是默认的输出文件名或目录。 仅文档节点
在记录时将考虑在具有此名称的包节点内。

--解析-impl
（实验性）尝试解析一个单元的实现，这可以用于
语法检查。

--project=文件
这个选项告诉 文件 从项目文件中读取所有选项。 这是一个 XML
文件，请参阅文档以获取有关此格式的更多信息
文件中。

--显示私人
默认情况下，不会为私有方法或字段生成任何文档。 这个
选择原因 文件 也为这些方法生成文档。

--详细
默认情况下， 文件 输出稀疏。 这告诉 fpdoc 生成更多
关于它正在做什么的信息。

--警告无节点
如果指定了这个选项， 文件 如果没有找到将发出警告
它正在记录的标识符的描述节点。

--write-project=文件
如果指定了这个选项， 文件 将写入一个 fpdoc 项目文件（到
指定的文件名）对应于给定的命令行选项。

使用 onworks.net 服务在线使用 fpdoc-3.0.0