Developer Aspirations

YAPB - Yet Another Programming Blog

Comments

Friday

07

January 2011

Why You Should Comment

by Colin Miller, on Comments, Design, development, Musings, requirements

I almost wonder why I would even have to make a post like this. It seems like common sense doesn't it? When you write new code, you should write comments with your code to explain what the code is doing. Sometimes the comments should be inline for a tricky algorithm, but often it's sufficient to place comments at the start of a method/function or class just to describe what…