When not to comment: Questions and tradeoffs with API documentation for C++ projects (2018)
Many developers dislike writing documentation. However, if someone else’s code isn’t sufficiently well-documented, they’re often the first to complain about it. Thanks to this study by Head, Sadowski, Murphy-Hill, and Knight, we now know how much you should invest in API documentation (and how much you can get away with).
Characteristics of useful code reviews: An empirical study at Microsoft (2015)
Last week, we’ve learnt that reviewing and discussing code is a good way to catch bugs. That obviously doesn’t mean you should meticulously review and start arguments about every single line of code – but what should you do then? This week I discuss a paper by Bosu, Greiler, and Bird that explains what makes code reviews useful.
The impact of code review coverage and code review participation on software quality (2014)
Code reviews are often used as a way to make sure that bad code doesn’t make it into public releases. Not all code reviews are equal for that purpose however, as this study by McIntosh, Kamei, Adams, and Hassan shows.
Datetime formatting in Go
time package takes a novel approach to defining datetime serialisation formats. Is it an improvement over existing alternatives?