CodeSOD: Time Sensitive Comments

One of the arguments against comments in code is that they create a need to have two things updated: the code and the documentation have to be kept in sync. Inevitably, they'll drift apart.

David works with a junior developer who came onto the team with strong opinions about, well, everything. One of those strong opinions is that every single line needs to have comments. Each and every one.

This is the end result:

// update timeout status to 24rs contact.ActivationValidUntil = providers.SystemDate.SystemDateTime.AddDays(30);

So, just a slight drift between the code and the comment. What's 29 days of drift between friends?

[Advertisement] Utilize BuildMaster to release your software with confidence, at the pace your business demands. Download today!

This post originally appeared on The Daily WTF.

Comments are closed.