Die Dokumentation eines benutzerdefinierten Geoverarbeitungswerkzeugs ermöglicht es anderen, Ihr Werkzeug zu verstehen und effizient zu nutzen. Die Dokumentation kann zum Teil über das Dialogfeld für die Werkzeugeigenschaften und über die Metadaten des Werkzeugs erstellt werden.
Werkzeugeigenschaften
Stellen Sie die unten aufgeführten Eigenschaften ein, um das Werkzeug im Dialogfeld Eigenschaften zu dokumentieren. Um das Dialogfeld Eigenschaften zu öffnen, klicken Sie mit der rechten Maustaste auf das Werkzeug im Fenster Katalog.
- Geben Sie auf der seitlichen Registerkarte Allgemein eine Werkzeugbeschreibung, eine Zusammenfassung und eine Abbildung an.
- Legen Sie auf der Registerkarte Parameter eine Beschreibung für jeden Parameter fest, die im Dialogfeld des Werkzeugs angezeigt wird, wenn Sie den Mauszeiger auf die Schaltfläche Informationen
neben der Parameterbezeichnung bewegen.
Metadaten
Beim Verfassen der vollständigen Hilfedokumentation für ein Werkzeug ändern Sie dessen Metadaten bzw. Elementbeschreibung, wozu folgende Komponenten zählen:
- Titel: Der Name des benutzerdefinierten Werkzeugs.
- Miniaturansicht: Eine Miniaturansicht, die angezeigt wird, wenn Sie den Mauszeiger über das Werkzeug im Fenster Katalog bewegen.
- Tags: Schlüsselwörter für die Suche nach Werkzeugen im Fenster Katalog oder in der Ansicht Katalog.
- Zusammenfassung (Kurzfassung): Eine Zusammenfassung des Tasks, der von Ihrem Werkzeug ausgeführt wird, sowie kurze Anwendungsfälle Die Zusammenfassung wird angezeigt, wenn Sie den Mauszeiger über die Schaltfläche Hilfe
im Fenster Geoverarbeitung bewegen.Hinweis:
Wenn die Zusammenfassung in den Metadaten des Werkzeugs und im Dialogfeld Eigenschaften eingestellt ist, wird die Zusammenfassung aus den Werkzeugeigenschaften im Werkzeugdialogfeld angezeigt.
- Verwendung: Allgemeine Tipps oder Anweisungen zur richtigen und effizienten Verwendung des Werkzeugs.
- Syntax: Spezifische Hilfe für jeden Parameter, einschließlich zulässiger Datentypen und Werte
In den Metadaten können auch Codebeispiele, Danksagungen, Verwendungsbeschränkungen und ein Begrenzungsrahmen dokumentiert werden.
Um das benutzerdefinierte Geoverarbeitungswerkzeug und die Toolbox zu dokumentieren, können Sie mit der rechten Maustaste auf das Werkzeug oder die Toolbox klicken und Metadaten bearbeiten auswählen. Alternativ können Sie mit der rechten Maustaste auf das Werkzeug oder die Toolbox klicken, Metadaten anzeigen auswählen und auf die Schaltfläche Bearbeiten 
auf der Registerkarte Katalog klicken. Nachdem Sie Ihr benutzerdefiniertes Werkzeug dokumentiert haben, kann jeder, der das Werkzeug verwendet, die Hilfe auf dieselbe Weise abrufen wie für die in ArcGIS Pro integrierten Geoverarbeitungswerkzeuge.