为自定义地理处理工具编写文档可帮助其他人了解并有效地使用您的工具。 可以使用工具属性对话框以及工具元数据来创作文档的一部分。
工具属性
设置下列属性以便在属性对话框中编写工具文档。 要打开属性对话框,请右键单击目录窗格中的工具。
元数据
要编写工具的完整帮助文档,请修改其元数据或项目描述,其中包含以下组成部分:
- 标题 - 自定义工具的名称。
- 缩略图 - 将鼠标悬停在目录窗格中的工具上时显示的缩略图。
- 标签 - 用于在目录窗格或目录视图中搜索工具的关键字。
- 汇总(摘要)- 工具所执行任务的摘要以及简短的用例。 将鼠标悬停在地理处理窗格中的帮助按钮 上时,将显示摘要。
注:
如果在工具元数据和属性对话框中设置了摘要,则工具属性中的摘要将显示在工具对话框中。
- 用法 - 有关如何正确高效地使用该工具的一般性提示和说明。
- 语法 - 针对每个参数的特定帮助,其中包括可接受的数据类型和值。
代码示例、配额、使用限制和边界框也可以记录在元数据中。
要记录自定义地理处理工具和工具箱,可以右键单击该工具或工具箱,然后选择编辑元数据。 或者,右键单击工具或工具框,选择查看元数据,然后单击目录选项卡上的编辑按钮 。 为自定义工具创建文档后,任何使用该工具的用户均可获取其帮助,其获取方式与 ArcGIS Pro 中地理处理工具帮助的获取方式相同。