epydocgui - 云端在线

程序：

您的姓名

epydocgui - epydoc 的图形界面

概要

附注 [项目.prj | 模块...]

文档 -h

文档 -V

商品描述

附注 是 epydoc 的图形界面，它为 Python 生成 API 文档
模块和包，基于它们的文档字符串。 一种轻量级的标记语言，称为
文本 可用于格式化文档字符串，并添加有关特定字段的信息，
例如参数和实例变量。

API 文档由 附注 由一组 HTML 文件组成。 二
为公共和私有文档创建子目录。 在每个
子目录中，每个类和模块都记录在自己的文件中。 一个索引文件，一个
树文件和帮助文件也被创建。 如果您选择 帧 选项，然后一个
还生成基于框架的目录。

配置

项目.prj
保存的项目文件的名称 附注. 项目文件记录一个
相关模块的列表，以及应该用于生成
这些模块的文档。

模块...
应该记录的模块列表。 可以使用指定的模块
模块名称（例如 操作系统路径)、文件名（例如 epydoc/epytext.py), 或目录
名称（例如 文档/）。 目录名称指定包，并扩展为
包括所有子模块和子包。

-H， - 帮助， - 用法， -?
显示使用消息。

-V, - 版
打印 Epydoc 的版本。

HTML FILES

API 文档由 文档 由以下文件组成：

index.html的
文档的标准入口点。 一般， index.html的 是一个
帧索引文件，它定义了三个帧：左侧的两个帧
浏览器包含一个目录，右侧是主框架
窗口包含文档页面。 但如果 --无帧 选项是
使用，然后 index.html的 将用户重定向到项目的首页。

m-模块.html
模块的 API 文档。 模块 是完整的虚线名称
模块，例如 系统 or epydoc.epytext.

c类.html
类、异常或类型的 API 文档。 c 是完整的
类的虚线名称，例如 epydoc.epytext.Token or 数组.ArrayType.

树.html
模块和类层次结构。

索引.html
术语和标识符索引。

帮助.html
项目的帮助页面。 此页面说明如何使用和导航
epydoc 制作的网页。

目录.html
顶级目录页面。 此页面显示在左上角
框架，并提供链接到 toc-everything.html 和 目录-m-模块的.html
文件。 目录.html 如果 --无帧 选项被使用。

toc-everything.html
整个项目的目录。 此页面显示在
左下框，并提供指向每个类、类型、异常、函数、
和项目定义的变量。 toc-everything.html 不生成，如果
此 --无帧 选项被使用。

目录-m-模块的.html
模块的目录。 该页面显示在左下角
框架，并提供指向每个类、类型、异常、函数和
模块定义的变量。 模块 是完整的虚线名称
模块，例如 系统 or epydoc.epytext. 目录-m-模块的.html 不生成，如果
此 --无帧 选项被使用。

文件
用于显示所有 HTML 页面的 CSS 样式表。

默认情况下， 文档 在输出目录中创建两个子目录： 国家 和 私立.
每个目录都包含上面指定的所有文件。 但如果 --无私人 选项
使用，则不创建子目录，编写公共文档
直接到输出目录。 分为五类：导入错误； 文本
错误； epytext 警告； 现场警告； 和检查错误。 每当 epydoc
遇到错误，它会发出描述错误的警告消息，并尝试
继续生成文档。

导入错误表明 epydoc 无法导入模块。 导入错误通常
防止 epydoc 为相关模块生成文档。 Epydoc 可以
生成以下导入错误：

坏 模块 姓名 模块
Epydoc 尝试导入 模块，但 模块 不是 Python 的有效名称
模块。

莫非 而不去 发现 a UID 链接目标
Epydoc 无法找到内联链接构造所引用的对象
(大{...}）。 这通常是由链接中的拼写错误引起的。

莫非 而不去 进口 模块
Epydoc 尝试导入 模块，但失败了。 这通常发生在
模块 引发异常。

文件 不 而不去 存在
Epydoc 试图导入包含在 文件，但 文件 才不是
存在。

Epytext 错误是由包含无效标记的 epytext 文档字符串引起的。 每当一个
检测到 epytext 错误，有问题的文档字符串被视为纯文本文档字符串。
Epydoc 可以生成以下 epytext 错误：

坏 链接 目标。
为内联链接构造指定的目标 (大{...}) 不太好-
形成。 链接目标必须是有效的 Python 标识符。

坏 URI 目标。
为内联 uri 构造指定的目标 (你{...}) 格式不正确。
如果内联标记嵌套在 URI 目标内，通常会发生这种情况。

字段 必须 be at 此 最佳 水平。
字段列表（@参数等）包含在其他一些块结构中
（例如列表或部分）。

字段 必须 be 此 最后 元素。
字段列表（@参数等）不在文档字符串的末尾。

标题 必须 发生 at 最佳 水平。
标题包含在其他一些块结构（例如列表）中。

不当 文档测试 阻止 缩进。
doctest 块超出其初始提示行的缩进。

不当 标题 缩进。
节的标题与节中的段落左对齐
包含它的部分。

不当 第 缩进。
块内的段落不是左对齐的。 这个错误经常
使用 epytext 解析纯文本文档字符串时生成。

无效 逃逸。
未知的转义序列与内联转义结构一起使用
(E{...}).

书单 必须 be 缩进。
紧跟段落后的未缩进行以列表项目符号开头。
Epydoc 不确定您是打算开始一个新的列表项，还是打算
段落以包含一个看起来像项目符号的单词。 如果你打算
前者，然后缩进列表。 如果您打算使用后者，请更改
段落的自动换行，或转义该单词的第一个字符
看起来像一颗子弹。

不平衡 '{'。
文档字符串包含不平衡的大括号。 Epytext 要求所有大括号
必须平衡。 要包含单个不平衡支撑，请使用转义符
序列 E{lb}（左大括号）和 E{rb}（右大括号）。

不平衡 '}'。
文档字符串包含不平衡的大括号。 Epytext 要求所有大括号
必须平衡。 要包含单个不平衡支撑，请使用转义符
序列 E{lb}（左大括号）和 E{rb}（右大括号）。

不明 一致 标记 标签。
内联标记结构使用了一个未知标签 ( x{...} ).

错误 强调 字符 标题。
本节标题使用的下划线字符不表示
相应的部门级别。 “=”字符应该用于下划线
部分； “-”为小节； 和“〜”为子小节。

Epytext 警告是由包含可疑或可疑的 epytext 文档字符串引起的
标记。 Epytext 警告做 而不去 防止有问题的文档字符串被解析。
Epydoc 可以生成以下 epytext 警告：

可能 格式错误 部分 项目。
Epytext 检测到一行看起来像字段项，但不正确
格式化。 这通常发生在不包括尾随冒号 (":") 时
在字段标记中。

可能 标题 错字。
Epytext 检测到一对看起来像标题的行，但是
下划线字符与标题中的字符数不匹配。
这两行中的字符数必须完全匹配才能使它们成为
视为标题。

字段警告是由包含无效字段的 epytext 文档字符串引起的。 内容
无效字段的通常会被忽略。 Epydoc 可以生成以下字段
警告：

@参数 不明 参数 停止.
@param 字段用于指定参数的类型
包含在函数的签名中。 这通常是由输入错误引起的
参数名称。

行李牌 做了 而不去 期望 an 论据。
字段标记 行李牌 与一个参数一起使用，但它不需要一个。

行李牌 预期 an 论据。
字段标记 行李牌 不带参数使用，但它需要一个。

@类型 不明 参数 停止.
@type 字段用于指定未包含的参数的类型
在函数的签名中。 这通常是由输入错误引起的
参数名称。

@类型 不明 变量 VAR.
@type 字段用于指定变量的类型，但没有其他字段
变量的信息是已知的。 这通常是由输入错误引起的
变量名。

不明 部分 行李牌 行李牌.
文档字符串包含一个带有未知标签的字段 行李牌.

重新定义 of 部分.
多个字段标签定义的值 部分 在同一个文档字符串中，但是 部分
只能取一个值。

如果 epydoc 在尝试检查时遇到问题，则会生成检查错误
记录对象的属性。 大多数检查错误并不能阻止 epydoc
从记录有问题的对象。 Epydoc可以生成如下检查
错误：

这款 参数 of 方法 do 而不去 匹配 基本方法.
未记录方法的参数 方法 参数不匹配
基类方法 基本方法 它覆盖。 其结果， 方法
不继承文档 基本方法。 如果在
参数是故意的，那么你可以通过添加一个来消除警告
（可能为空）文档字符串到 方法.

文档地图 不能 加 a 类型
Epydoc 试图记录一个未知类型的对象。 这个错误是
通常由操作导入的包和模块生成
机制，这样导入模块会产生一些其他类型的对象。

UID 冲突 检测到： 的uid
epydoc 为两个不同的对象分配了相同的唯一标识符。 这个
可能会导致 epydoc 将一个对象的文档替换为
分配了相同唯一标识符的另一个对象的文档。
但是，这通常只会在两个对象具有相同
唯一标识符既是模块又是类，在这种情况下，API
一个对象的文档页面将覆盖 API 文档页面
另一个对象。

对象 出现 in 多 内建的 模块
在尝试确定哪个模块定义了内置对象时 对象,
epydoc 遇到了多个候选人，无法决定哪个
候选人是正确的。 在这种情况下，epydoc 任意选择第一个
它找到的候选人。

对象 出现 in 多 的.py 模块
在尝试确定哪个模块定义了内置对象时 对象,
epydoc 遇到了多个候选人，无法决定哪个
候选人是正确的。 在这种情况下，epydoc 任意选择第一个
它找到的候选人。

对象 出现 in 多 。所以 模块
在尝试确定哪个模块定义了内置对象时 对象,
epydoc 遇到了多个候选人，无法决定哪个
候选人是正确的。 在这种情况下，epydoc 任意选择第一个
它找到的候选人。

莫非 而不去 发现 a 模块 对象
Epydoc 无法确定哪个模块定义 对象。 如果 对象 是一个
函数，那么这将阻止 epydoc 生成任何文档
对象，因为它不知道将文档放在哪个页面上。
否则，这将阻止文档 对象 从包含链接
到其包含模块。

使用 onworks.net 服务在线使用 epydocgui