n-daisuke897-blog/src/blog/post-3.md

560 B

title pubDate author tags
Why I Write Docstrings 2025-05-16 Nakahara Daisuke
programming

I try to write docstrings as much as possible for two main reasons. First, they help reviewers understand the roles of functions and classes. Second, I believe that clear, detailed docstrings can enable AI tools to generate code more effectively.

Although I sometimes make mistakes in my docstrings, I think that even imperfect documentation is better than none. Moreover, both reviewers and AI tools can help identify and correct these errors.