Python Forum
Thread Rating:
  • 0 Vote(s) - 0 Average
  • 1
  • 2
  • 3
  • 4
  • 5
Python beginner
#11
(Jun-24-2018, 05:30 PM)gontajones Wrote: I completely agree with you. But maybe a beginner would read this and ask why the 'month' ('m' in my case) variable exists.

    for month in range(months):         # count once for each month
        borrowed *= 1 + interest / 12   # & compound the interest
        borrowed -= repayment           # & subtract repayment
    print(borrowed)                     # then, print the remaining amount borrowed
Big Grin I like that we are in agreement
If you add some comments it should be clear for all. I tutor online and I've found most students are sorely lacking commenting skills.
Reply
#12
Thanks very much to you both for these answers :)
I had no idea how to do this before so its good to see/learn this code! It workssssss!

BigD
Reply
#13
(Jun-24-2018, 05:37 PM)Grok_It Wrote: If you add some comments it should be clear for all.
    for month in range(months):         # count once for each month
        borrowed *= 1 + interest / 12   # & compound the interest
        borrowed -= repayment           # & subtract repayment
    print(borrowed)                     # then, print the remaining amount borrowed

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)...
If you can't explain it to a six year old, you don't understand it yourself, Albert Einstein
How to Ask Questions The Smart Way: link and another link
Create MCV example
Debug small programs

Reply
#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
#15
(Jun-25-2018, 06:32 PM)Grok_It Wrote: So, you'd trade fast code for slow but denigrate comments that make the fast code clear for a beginner to understand?

I don't know how you come to a conclusions what I would trade from my opinion about the comments you added to the code...
You suggested adding comments so that it should "be clear for all" and I expressed my opinion about the comments you added to the code
If you can't explain it to a six year old, you don't understand it yourself, Albert Einstein
How to Ask Questions The Smart Way: link and another link
Create MCV example
Debug small programs

Reply


Forum Jump:

User Panel Messages

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