From the course: Learning ArcGIS Python Scripting (2018)
Join today to access over 22,600 courses taught by industry experts or purchase this course individually.
Documenting a script - ArcGIS Tutorial
From the course: Learning ArcGIS Python Scripting (2018)
Documenting a script
- [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…
Practice while you learn with exercise files
Download the files the instructor uses to teach the course. Follow along and learn by watching, listening and practicing.
Download courses and learn on the go
Watch courses on your mobile device without an internet connection. Download courses using your iOS or Android LinkedIn Learning app.