From the course: Visual Studio Code for Python Developers

Unlock the full course today

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

Better Comments

Better Comments

From the course: Visual Studio Code for Python Developers

Start my 1-month free trial

Better Comments

- [Narrator] In addition to writing good, detailed docstrings, comments are another important aspect of writing good code. One of the main challenges with comments, however, is that they are often used for a variety of purposes. So let's open up our source code and you can see what I mean here. Comments can be used to indicate work items in the form of to-dos, and sometimes they warn developers of tricky situations, sometimes they serve as reminders, and other times they are used to actually document how a particular part of the app works. But visually, however, they look all the same. You can see that in my code here, that they're all the same green color. Even though each of these comments serves a different purposes, there's no visual distinction. The Better Comments extension helps address this by making different kinds of comments have their own appearance. So once again, let's go to the extensions view, and I'll search for Better Comments. And the first hit right is the one we…

Contents