记录自定义地理处理工具

为自定义地理处理工具编写文档可帮助其他人了解并有效地使用您的工具。 可以使用工具属性对话框以及工具元数据来创作文档的一部分。

工具属性

设置下列属性以便在 属性 对话框中编写工具文档。 要打开 属性 对话框，请右键单击 目录 窗格中的工具。

• 在 常规 侧选项卡上，提供工具描述、摘要和图示。

• 在 参数 侧选项卡上，为每个参数设置描述，当您将鼠标悬停在参数标注旁边的 信息 按钮 上时，将在工具对话框上显示该描述。

元数据

要编写工具的完整帮助文档，请修改其元数据或项目描述，其中包含以下组成部分：

• 标题 - 自定义工具的名称。

• 缩略图 - 将鼠标悬停在 目录 窗格中的工具上时显示的缩略图。

• 标签 - 用于在 目录 窗格或 目录 视图中搜索工具的关键字。

• 汇总（摘要） - 工具所执行任务的摘要以及简短的用例。 将鼠标悬停在 地理处理 窗格中的 帮助 按钮 上时，将显示摘要。

  注:

  如果在工具元数据和 属性 对话框中设置了摘要，则工具属性中的摘要将显示在工具对话框中。

• 用法 - 有关如何正确高效地使用该工具的一般性提示和说明。

• 语法 - 针对每个参数的特定帮助，其中包括可接受的数据类型和值。

代码示例、制作者、使用限制和边界框也可以记录在元数据中。

要记录自定义地理处理工具和工具箱，可以右键单击该工具或工具箱，然后选择 编辑元数据 。 或者，右键单击工具或工具框，选择 查看元数据 ，然后单击 目录 选项卡上的 编辑 按钮 。 为自定义工具创建文档后，任何使用该工具的用户均可获取其帮助，其获取方式与 ArcGIS Pro 中地理处理工具帮助的获取方式相同。