编写工具和工具箱文档说明的快速浏览

要编写工具或工具箱的文档说明，可按以下描述对描述页面进行编辑。

注:

工具集不具有项目描述，您无法为工具集输入任何文档说明。

编辑描述页面

可通过多种方法访问工具或工具箱的描述页面。

在目录 窗口中

• 右键单击所创建的工具或工具箱，然后单击项目描述。将打开项目描述 窗口，其中显示了描述页面。
• 单击编辑按钮 。

在 ArcCatalog 中

• 在目录树视图中，选择您所创建的工具或工具箱。
• 在内容面板中，单击描述选项卡。
• 单击编辑按钮 。

搜索 窗口中

如果工具或工具箱是搜索 窗口中列出的搜索结果（如查找工具快速浏览中所述），则可执行以下操作来访问其描述页面：

• 将指针悬停在工具或工具箱名称上；将弹出一个窗口，其底部包含一个指向项目描述的链接。单击该链接打开项目描述 窗口，然后单击编辑按钮 。
• 单击工具或工具箱名称下面的摘要行以打开项目描述 窗口，然后单击编辑按钮 。

输入工具描述

工具的描述页面也使用了一个由 ArcGIS 提供的标准模板，而且其结构与系统工具参考页面完全相同。这个页面最初是空白页面，只显示默认内容，如工具名称、参数名称和参数数据类型。您需要依照编辑器底部提供的提示在以下区域填写相关信息：

• 标题：可为工具输入一个可能更具描述性的不同标题。这个替换标题将显示在项目描述页面中。
• 缩略图：可以浏览到一个说明该工具用途的图像文件（如 .jpg 或 .png）。我们建议图形宽度不超过 600 像素，如果宽度更大，图形可能会在打印时被截断。
  注:

  该图像仅显示在项目描述中，而不显示在该工具的侧面板帮助中。

• 标签：可以输入用于在系统中标识工具主题的词语。
• 摘要：可以编写一个关于该工具用途的简短摘要。
• 用法：可以输入一条或多条用户需要了解的重要提示。
• 语法：工具语法定义工具的参数以及这些参数对工具执行结果的影响方式。虽然参数名称和类型会自动填入表中，但是您需要输入这些参数的说明：
  • 对话框说明是工具对话框中参数的参考。单击显示帮助 时，此参考将显示在工具对话框的侧面板中。
  • 脚本说明是同一个参数在脚本中使用时的参考。此参考显示在“项目描述”页面上以及 Python 窗口的“帮助”部分。
  对于大多数参数来说，对话框说明与脚本说明是相同的。但对于某些参数来说（例如，对话框中的复选框（脚本中使用关键字的布尔值），或对话框中的多重输入字段（脚本中的多值参数）），您可能需要以不同方式解释它们，声明用户如何与对话框控件进行交互以及如何在脚本中指定关键字或值。
• 代码示例：可以提供一个或多个 Python 代码示例，演示如何在 Python 中使用工具。对于每个示例，您可提供一个标题、示例描述以及 Python 代码。
• 工具侧边栏帮助图像：此图像显示在工具的侧面板帮助中。我们建议图形宽度不超过 400 像素。
• 制作者名单：可以确认提供该工具设计与实现的人员或组织。

输入工具箱描述

工具箱的描述页面使用 ArcGIS 提供的标准模板。这个页面最初是一个空白页面，只显示默认内容，如工具箱名称以及工具箱中的工具集。您需要依照编辑器底部提供的提示在以下区域填写相关信息：

• 标题：可为工具箱输入一个可能更具描述性的不同标题。这个替换标题将显示在描述页面中。
• 缩略图：可以浏览到一个说明该工具箱所含内容的图像文件，如 .jpg 或 .png。
• 标签：可以输入用于在系统中标识工具箱的主题或内容的词语。
• 摘要：可以编写一个关于该工具箱所含内容的简短摘要。
• 描述：可以对工具箱进行更为详细的说明。
• 制作者名单：可以确认提供资源的人员或组织。

在搜索中使用项目描述

搜索 窗口使用“项目描述”中提供的文本说明来查找工具。“搜索”下次为工具建立索引时，将对摘要和关键字进行解析，并将它们添加到搜索索引中。

了解有关 ArcGIS 搜索和建立索引的详细信息