Join us and get access to thousands of tutorials and a community of expert Pythonistas.
This lesson is for members only. Join us and get access to thousands of tutorials and a community of expert Pythonistas.
Conclusion and How to Practice Your Commenting Skills
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! What’s your #1 takeaway or favorite thing you learned? How are you going to put your newfound skills to use? Leave a comment in the discussion section and let us know.
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. Sketch out that outline and start coding it as you go. Develop your own comment system.
00:17 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. In this video guide, we’ve covered a variety of ways comments can help you and the people who read your code.
00:44 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.
wjhopson on March 15, 2019
Thanks, I found the subtleties of comments like what not to include in a comment very helpful.
Edgar Isai on March 15, 2019
Thank you, these are very helpful tips.
SamR on March 15, 2019
Very useful, thanks!
Blaise Pabon on March 19, 2019
I listened to this while I did the dishes and it was useful. I would like to learn how to do fancy google style docstrings some day. maybe that is what @prerit has in mind.
Chaitanya on March 21, 2019
A nice way of explaining about comments, especially the purposes listed down is awesome :)
Jackie Wilson RP Team on March 28, 2019
Thanks for the feedback everybody!
Jaya Z on March 29, 2019
This was wonderful Jackie!!
TheCthulhuKid on April 5, 2019
A video I wish I had seen when I started =) Cheers!
victorariasvanegas on June 13, 2019
I would like to know more about how to build docstrings and #TODO, very good video congratulations.
Abby Jones on June 27, 2019
Basic? Yes. Still important to know? Yes.
rklyba on July 8, 2019
Thank you for a good course.
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
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.
Prerit Anwekar on March 15, 2019
These are very basic. :(