Writing Comments About the Obvious Things - Deepstash

Writing Comments About the Obvious Things

Most comments can be replaced with Better-Named elements in your code. If you are tempted to write a what comment to clarify the code, please do not point out the obvious. Remove comments like these if you have to deal with them.

Educate programmers who write comments about how bad they are. 

597

2.22K reads

CURATED FROM

IDEAS CURATED BY

sarakelly

Product designer

The idea is part of this collection:

Metaverse

Learn more about computerscience with this collection

Find out the challenges it poses

Learn about the potential impact on society

Understanding the concept of Metaverse

Related collections

Similar ideas to Writing Comments About the Obvious Things

Use comments to mark incomplete implementations

Sometimes it’s necessary to check in code even though it has known limitations. While it can be tempting not to share known deficiencies in one’s code, it is better to make these explicit, such as with a TODO comment:

// TODO: We are making the decimal separator be a period,

Learning with the Feynman technique

  • Step 1: Pick something you want to learn. Spend time with the idea until you have internalized it as best you can.
  • Step 2: From memory, write everything down that you know about the subject in a way that a child can understand. Write the items down...

7 Things You Need To Understand About Anxiety And Depression

No, we are not over yet. After discussing the topic with my friend’s Dad (he is a doctor), I’ve made a list of things you need to understand and avoid anxiety attacks (hard to breathe moments).

  1. Think of your anxiety as a biological problem, rather than thinking there is something wron...

Read & Learn

20x Faster

without
deepstash

with
deepstash

with

deepstash

Personalized microlearning

100+ Learning Journeys

Access to 200,000+ ideas

Access to the mobile app

Unlimited idea saving

Unlimited history

Unlimited listening to ideas

Downloading & offline access

Supercharge your mind with one idea per day

Enter your email and spend 1 minute every day to learn something new.

Email

I agree to receive email updates