In this video, Jennifer Harrison shows how to create help documentation for custom ArcMap script tools. See how to edit the item description to create the help documentation.
- [Instructor] Whether you intend to share your scripts…or just keep your scripts for yourself,…you need to spend a few minutes to document…their purpose and the proper way to use them.…This makes it easy to come back to the script…at any time in the future…and run it or make updates to it.…I have a script open here in IDLE,…it's called SearchForBrokenLinks.…You can see that there's lots of red text.…Those are all the comments that…I've put into the script to explain it.…You can, and should, always document your script…with a title block and pseudo code in the script,…as you're building it.…
Comments always start with a hash tag.…Comments are really great for yourself,…and for the developers who come along behind you.…But you should also document your script…for end users, and that's done over in ArcMap.…Your GIS Python scripts will likely be run…through a tool in our tool box.…You can create help document and metadata for the tool…by simply filling in the item description.…If I right click on this custom tool called Buffer a Site,…
- Writing and running Python scripts in IDLE
- Making scripts flexible with variables
- Commenting scripts
- Manipulating string data
- Object-oriented programming in Python
- Creating loops
- Reading and writing text files
- Capturing input at runtime
- Documenting your scripts
Skill Level Beginner
1. Python for ArcGIS Basics
2. Strings, Numbers, and Variables
Work with numeric values5m 22s
3. Syntax Rules
4. Manipulating Strings
5. Object-Oriented Programming
6. Using Loops
7. Generate Log Files
8. Input at Run Time
9. Help Documents
Documenting a script1m 59s
- Mark as unwatched
- Mark all as unwatched
Are you sure you want to mark all the videos in this course as unwatched?
This will not affect your course history, your reports, or your certificates of completion for this course.Cancel
Take notes with your new membership!
Type in the entry box, then click Enter to save your note.
1:30Press on any video thumbnail to jump immediately to the timecode shown.
Notes are saved with you account but can also be exported as plain text, MS Word, PDF, Google Doc, or Evernote.