Best practices for writing code comments

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/12/23/best-practices-for-writing-code-comments/

Utworzony 3y | 23 gru 2021, 15:21:28


Zaloguj się, aby dodać komentarz

Inne posty w tej grupie

Durable execution: autosave for your microservices

Ryan is joined by Jeremy Edberg, CEO of DBOS, and Qian Li, co-founder of DBOS, to discuss durable execution and its use cases, its implementation using technologies like PostgreSQL, and its applicatio

21 maj 2025, 17:10:08 | StackOverflow blog
CEO Update: Exploration and experimentation for bold evolution

As we envision what the ideal future version of Stack Overflow looks like, we’re committed to engaging with our community. https://stackoverflow.blog/2025/05/20/ceo-update-exploration-and-experimentat

21 maj 2025, 14:40:10 | StackOverflow blog
Research roadmap update, May 2025

An update to the research that the User Experience team is running over the next quarter. https://stackoverflow.blog/2025/05/19/research-roadmap-update-may-2025/

19 maj 2025, 14:10:11 | StackOverflow blog
Salesforce wants to do for agentic AI what they did for SaaS

Christophe Coenraets, SVP of Developer Relations at Salesforce, tells Eira and Ben about building the new Salesforce Developer Edition, which includes access to the company’s agentic AI platform, Agen

16 maj 2025, 04:50:09 | StackOverflow blog
Next-level observability: live breakpoint debugging

On this episode, Ryan chats with Hendrik Rexed, Cloud Native Advocate at Dynatrace, about debugging cloud-based applications like you would a local app. https://stackoverflow.blog/2025/05/13/next-lev

14 maj 2025, 06:40:02 | StackOverflow blog
Is the enterprise (actually) ready for AI?

Maryam Ashoori, Head of Product for watsonx.ai at IBM, joins Ryan and Eira to talk about the complexity of enterprise AI, the role of governance, the AI skill gap among developers, how AI coding tools

13 maj 2025, 05:10:07 | StackOverflow blog