Representative Line: Something Wonderful
by Remy Porter from The Daily WTF on (#77AEZ)
Today, we look at a "representative comment" from Mark W. This particular comment appears on a function:
/// <summary>/// Does something wonderful./// </summary>
Well, I'm glad it's wonderful, but are we talking "Christmas magic" wonderful? Or sarcastically droll "Oh, how wonderful for you." wonderful? Tone doesn't get conveyed in text very well, so you've really got to be precise with your wording if you want us to get it.
Mark writes:
This comment is not really a 'representative' line; it exists in an otherwise very well written 100k+ line codebase.
Maybe it's not representative of the codebase as a whole, but it clearly represents this section of the codebase wonderfully.
[Advertisement] BuildMaster allows you to create a self-service release management platform that allows different teams to manage their applications. Explore how!