Python Forum
Thread Rating:
  • 0 Vote(s) - 0 Average
  • 1
  • 2
  • 3
  • 4
  • 5
Python beginner
#14
(Jun-25-2018, 10:18 AM)buran Wrote: Sorry, but I would disagree. What you provide is really bad example of comments (or if you want - really good example of bad comments). Check PEP8 about inline comments
Overuse of inline comments makes it hard to read the code and for simple lines (like these) are completely redundant. Good descriptive variable names would do. A short single-line block comment may be OK, but inline comments - definitely not. And given that it is actually a function - a docstring would be more than enough in this case (i.e. for a simple function like this one)...

Not worth arguing over
Reply


Messages In This Thread
Python beginner - by BigDisAok - Jun-23-2018, 11:18 AM
RE: Python beginner - by Nwb - Jun-23-2018, 11:57 AM
RE: Python beginner - by BigDisAok - Jun-23-2018, 12:23 PM
RE: Python beginner - by gontajones - Jun-23-2018, 01:08 PM
RE: Python beginner - by BigDisAok - Jun-23-2018, 01:12 PM
RE: Python beginner - by gontajones - Jun-23-2018, 01:21 PM
RE: Python beginner - by Grok_It - Jun-24-2018, 04:55 PM
RE: Python beginner - by gontajones - Jun-24-2018, 05:08 PM
RE: Python beginner - by Grok_It - Jun-24-2018, 05:27 PM
RE: Python beginner - by gontajones - Jun-24-2018, 05:30 PM
RE: Python beginner - by Grok_It - Jun-24-2018, 05:37 PM
RE: Python beginner - by BigDisAok - Jun-25-2018, 09:01 AM
RE: Python beginner - by buran - Jun-25-2018, 10:18 AM
RE: Python beginner - by Grok_It - Jun-25-2018, 06:36 PM
RE: Python beginner - by buran - Jun-25-2018, 06:41 PM

Forum Jump:

User Panel Messages

Announcements
Announcement #1 8/1/2020
Announcement #2 8/2/2020
Announcement #3 8/6/2020