Conclusion and How to Practice Your Commenting Skills

Writing Comments in Python Jackie Wilson 01:07

This lesson concludes the course on writing comments in Python. In this video, you’ll see several tips on how to practice commenting and also review everything you have learned up to this point.

Congratulations, you made it to the end of the course! Make it stick: Mentor AI will check what you’ve got down, help you build something with it, and find your #1 takeaway to share in the discussion.

Or go straight to the discussion section and share your #1 takeaway and how you’ll put your new skills to use.

00:00 Welcome to our final segment in our video guide for writing comments in Python. Now that you understand more about commenting, get started early when you begin your next project.

00:10 Sketch out that outline and start coding it as you go. Develop your own comment system. Maybe incorporate tags to help your workflow.

00:21 Go back in time and look at some of your older work and organize it better with comments. Look for opportunities on GitHub to comment shared code. You might even consider submitting your changes as a pull request, since that would help others.

00:36 In this video guide, we’ve covered a variety of ways comments can help you and the people who read your code. We’ve covered some best practices and some practices you’re better off avoiding.

00:51 Commenting is a relatively easy practice to implement, but the rewards and appreciation are big. Get started today. You’ll thank yourself later. Thank you for watching.

Tonya Sims on Aug. 6, 2019

Awesome video! I use comments quite often, possibly overuse them. Watching this helped me learn when and where to use then.

Pygator on Dec. 21, 2019

I really like the suggestion of using multiline # commments for algorithm development.

Lokman on March 14, 2020

Thanks for this comment course!

amicablezebra on April 15, 2020

This was way too basic. A bit of a disappointment to be honest.

Alan ODannel on July 15, 2020

Good refresher. Nice common sense practices. Enjoyed the Best practices and tips.

a5zima on July 20, 2020

Further information about docstrings you may need: PEP257 www.python.org/dev/peps/pep-0257/

aniketbarphe on Nov. 7, 2021

Thank You!

Abraham on Nov. 21, 2021

Great tips on outlining and when to use multi-string comments! Thanks!

Evgeniy Leybovich on Oct. 12, 2022

This is too basic course. No best practices on using tags # TODO:, how to describe Arguments and Returns, etc.

Martin Breuss RP Team on Oct. 13, 2022

Hi all, this course is meant as a beginner course (tagged as “basics”). If you want to dive deeper into commenting and especially documenting your code, then you can check out these resources tagged as “intermediate”:

📝 Tutorial: Documenting Python Code: A Complete Guide
📺 Video Course: Documenting Python Code: A Complete Guide

Hope this helps!

Become a Member to join the conversation.