To comment or not? A data-driven look at developer attitudes toward code comments
Next Day Video Next Day Video
68.3K subscribers
3,041 views
0

 Published On Apr 20, 2019

Veronica Hanus

https://www.pytexas.org/2019/talk/U2V...

Every programmer has asked themselves “how many comments are too many?” To the newest programmers, comments may seem magical--a way of documenting without giving instructions to the computer. But commenting engages the same vulnerability as more advanced challenges (i.e. pair programming & code review) and is likely to pique the insecurity of many programmers (especially the copy-and-paste or tutorial-level programmer)!

While most of us agree that commenting is part of writing maintainable code, it’s very difficult for someone who has not yet worked in a community-reviewed codebase to know what is good practice and not. The answers that come back often conflict each other: Code should be DRY, but well-placed comments save future devs. How can someone find the commenting style that is best for them as they learn, grow, & contribute? My survey of 170 long-time developers, Computer Science majors, bootcamp grads, & hobby programmers confirms some expectations and brings others into question. Join me for a data-based chat about the biggest pain points caused by our attitudes toward commenting and the steps we can take to encourage a growth mindset and empower programmers of all levels.

PyTexas2019

The PyTexas Foundation was organized as a Texas non-profit corporation in 2014 and received its 501(c)(3) recognition in early 2015. Although we cannot guarantee that your contribution to PyTexas will be tax-deductible (we aren’t tax attorneys and just don’t know), you can rest assured that any contributions to the organization will always be used to further the common goals of the Texas Python community, and never for personal benefit.

PyTexas is the annual, regional gathering for the Python community in Texas. PyTexas is organized and run by community volunteers. PyTexas, like most of the Python community, is focused on providing a diverse and enjoyable experience for everyone interested in Python. Please help us do that by following the code of conduct.

Produced by NDV:    / @nextdayvideo  

Python

Sat Apr 13 14:40:00 2019 at Special Event Center

show more

Share/Embed