While there are many resources to help programmers write better code—such as books and static analyzers—there are few for writing better comments. While it's easy to measure the quantity of comments in a program, it's hard to measure the quality, and the two are not necessarily correlated. A bad comment is worse than no comment at all. Here are some rules to help you achieve a happy medium. The post Best practices for writing code comments appeared first on Stack Overflow Blog.
https://stackoverflow.blog/2021/07/05/best-practices-for-writing-code-comments/
Login to add comment
Other posts in this group
Bottom line: let React do the React things. https://stackoverflow.blog/2025/01/07/wbit-2-memories-of-persistence-and-the-state-of-state/
Happy New Year! In this episode, Ryan talks with Jetify founder and CEO Daniel Loreto, a former engineering lead at Google and Twitter, about what AI applications have in common with Google Search. Th
This year, technologies such as JavaScript and PostgreSQL remain most popular, Rust and Markdown remain most admired, developers are most frustrated by technical debt at work, and they don’t see AI as
Is your preferred programming language a matter of national security? https://stackoverflow.blog/2024/12/30/in-rust-we-trust-white-house-office-urges-memory-safety/
It’s easy to generate code, but not so easy to generate good code. https://stackoverflow.blog/2024/12/31/generative-ai-is-not-going-to-build-your-engineering-team-for-you/
During the holidays, we’re releasing some highlights from a year full of conversations with developers and technologists. Enjoy! We’ll see you in 2025. https://stackoverflow.blog/2024/12/31/how-develo
A look at some of the current thinking around chunking data for retrieval-augmented generation (RAG) systems. https://stackoverflow.blog/2024/12/27/breaking-up-is-hard-to-do-chunking-in-rag-applicatio
