From the course: Learning ArcGIS Python Scripting (2018)

Unlock the full course today

Join today to access over 22,600 courses taught by industry experts or purchase this course individually.

Comment scripts

Comment scripts - ArcGIS Tutorial

From the course: Learning ArcGIS Python Scripting (2018)

Start my 1-month free trial

Comment scripts

- [Narrator] It's a really good idea to put some notes into a script to remind the author, and others, what the script is all about. These notes are added as comments. Comments are completely ignored by the Python compiler. Comments start with a hashtag; anything after the hashtag all the way to the end of the line, is ignored. You can put a space after the hashtag if you want, it's not required. It's standard practice to put a comment block at the top of each script that explains everything the script is gonna do. It also explains what inputs are required by the script, who created the script, the date it was created, and even what sort of outputs to expect from the script. Comment blocks are usually surrounded by lines of hashtags, So it'll often look something like this, just a whole bunch of these on a line. And then you put your comments in there, like the name of the script, as well as some information about the inputs and outputs required. Those angled brackets, the less than…

Contents