16
Avoid over-commenting in Python (www.pythonmorsels.com)
you are viewing a single comment's thread
view the rest of the comments
[-] hendrik@palaver.p3x.de 2 points 2 years ago* (last edited 2 years ago)

Agreed. Name things. And split up code into chunks with a sane lenth and have these methods do about one thing. And know the program language well enough so you don't need to do it in an unnecessarily complicated way. You can get rid of most of the inline comments that way. Not sure if this translates to docstrings though, if you're generating some reference or something. Yeah, and please tell me the "why" I can read Python code, so I can pretty much already see "what" it's doing.

this post was submitted on 12 Feb 2025
16 points (78.6% liked)

Python

8022 readers
2 users here now

Welcome to the Python community on the programming.dev Lemmy instance!

📅 Events

PastNovember 2023

October 2023

July 2023

August 2023

September 2023

🐍 Python project:
💓 Python Community:
✨ Python Ecosystem:
🌌 Fediverse
Communities
Projects
Feeds

founded 3 years ago
MODERATORS