In case you were unsure about whether or not you should be doing comments in your JavaScript, C#, SQL or Powershell Scripts or anything else for that matter, let me help you out – Comments are good, you need to do them, there is no excuse for not doing them.
You don’t need to be overly verbose in what you write in you comments going into major/minor versions, date of creation, what the weather was, etc, etc, you do need to find a format that accomplishes one goal…
Communicate the purpose of what you are doing.
Many times I have heard the following responses;
- If they don’t understand it, they shouldn’t be working on it.
- I speak differently than most.
- My code is written in a way that it speaks for itself and doesn’t