Can you give me some examples of bad commenting in code?
Sure! Bad commenting often includes comments that are obvious, outdated, or misleading. For example, a comment like 'This function adds two numbers' above a function that clearly adds two numbers is unnecessary.
What about comments that are too vague?
Exactly! Comments like 'This is important' without context are vague and don't help anyone understand the code better.
Are there any other common mistakes?
Yes, another common mistake is writing comments that don't match the code. For instance, if a comment says 'This function sorts an array' but the function actually filters the array, that's misleading.
How can I improve my commenting style?
To improve, focus on clarity and relevance. Write comments that explain why the code exists, not just what it does.
Get this answer and more from ChatGPT in Telegram, try it for free!
Get Started For FreePowered by advanced language models trained on billions of online words and conversations, MagicBuddy delivers friendly and helpful chat on demand.
Ask questions and get answers. Crack jokes and get laughs. Or even get writing ideas and study help. MagicBuddy's conversational intelligence allows for a truly unique and useful chat experience.
Curious? Try these prompts:
MagicBuddy is incredibly easy to use and the responses are lightning fast! 🥇
Impressive! MagicBuddy is my go-to AI assistant. It’s quick, accurate, and user-friendly.
Sending voice messages makes it easier to use in the middle of the day and the answers are super fast.
Love it! A friend of mine told me about it and it has made my life so much easier. It’s like having a helpful friend in my pocket!
I use 2 months already, simply amazing! MagicBuddy delivers answers in a snap. It’s a must-have tool for staying informed!
Game-changer! MagicBuddy’s speed and accuracy are unmatched. It’s my secret weapon for productivity
Say Hello to Your New Telegram BFF - Try MagicBuddy Free!
Get Started For Free