Click here to Skip to main content
15,220,241 members

The Insider News

   

The Insider News is for breaking IT and Software development news. Post your news, your alerts and your inside scoops. This is an IT news-only forum - all off-topic, non-news posts will be removed. If you wish to ask a programming question please post it here.

Get The Daily Insider direct to your mailbox every day. Subscribe now!

 
GeneralRe: End of an era: Microsoft Word now flagging two spaces after period as an error Pin
Chris Maunder13-Apr-20 10:10
cofounderChris Maunder13-Apr-20 10:10 
GeneralRe: End of an era: Microsoft Word now flagging two spaces after period as an error Pin
Mark_Wallace13-Apr-20 10:35
MemberMark_Wallace13-Apr-20 10:35 
GeneralRe: End of an era: Microsoft Word now flagging two spaces after period as an error Pin
Chris Maunder13-Apr-20 12:02
cofounderChris Maunder13-Apr-20 12:02 
News5 Code commenting don'ts Pin
Kent Sharkey12-Apr-20 13:00
staffKent Sharkey12-Apr-20 13:00 
GeneralRe: 5 Code commenting don'ts Pin
#realJSOP12-Apr-20 13:10
mva#realJSOP12-Apr-20 13:10 
GeneralRe: 5 Code commenting don'ts Pin
Mark_Wallace12-Apr-20 21:15
MemberMark_Wallace12-Apr-20 21:15 
GeneralRe: 5 Code commenting don'ts Pin
Mark_Wallace12-Apr-20 21:14
MemberMark_Wallace12-Apr-20 21:14 
GeneralRe: 5 Code commenting don'ts PinPopular
Chris Maunder13-Apr-20 4:09
cofounderChris Maunder13-Apr-20 4:09 
Quote:
Don't comment on the obvious

This dogma, more than anything else, is the root of all evil when it comes to "how to comment" posts.

I couldn't even guess the number of times someone has assumed something is "obvious" but is clearly highly ambiguous, or worse, totally and utterly not obvious. I've even done it myself: made a pithy comment since I thought it was obvious and then, 6 months later, had no idea what was going on.

And then there's the "obvious" at the time and for the situation, but then times and situations change. New functionality, new technology, even the changing use of terminology means things become un-obvious very quickly.

Comment always. Comment to clarify. Comment to tell the story of what you feel the code should be doing even if it's obvious because that one comment, that one tidbit, could save a dev a week of pain or worse - a catastrophically bad assumption.
cheers
Chris Maunder

GeneralRe: 5 Code commenting don'ts Pin
TheGreatAndPowerfulOz13-Apr-20 8:21
MemberTheGreatAndPowerfulOz13-Apr-20 8:21 
GeneralRe: 5 Code commenting don'ts Pin
markrlondon13-Apr-20 11:32
Membermarkrlondon13-Apr-20 11:32 
GeneralRe: 5 Code commenting don'ts Pin
TheGreatAndPowerfulOz13-Apr-20 15:03
MemberTheGreatAndPowerfulOz13-Apr-20 15:03 
GeneralRe: 5 Code commenting don'ts Pin
Mark_Wallace13-Apr-20 18:31
MemberMark_Wallace13-Apr-20 18:31 
GeneralRe: 5 Code commenting don'ts Pin
TheGreatAndPowerfulOz13-Apr-20 18:56
MemberTheGreatAndPowerfulOz13-Apr-20 18:56 
GeneralRe: 5 Code commenting don'ts Pin
Greg Utas13-Apr-20 11:52
professionalGreg Utas13-Apr-20 11:52 
GeneralRe: 5 Code commenting don'ts Pin
Bohdan Stupak13-Apr-20 5:47
professionalBohdan Stupak13-Apr-20 5:47 
GeneralRe: 5 Code commenting don'ts Pin
Nelek13-Apr-20 7:27
protectorNelek13-Apr-20 7:27 
GeneralRe: 5 Code commenting don'ts Pin
TheGreatAndPowerfulOz13-Apr-20 17:25
MemberTheGreatAndPowerfulOz13-Apr-20 17:25 
NewsSprayableTech: Large-scale interactive surfaces using airbrushed ink Pin
Kent Sharkey12-Apr-20 13:00
staffKent Sharkey12-Apr-20 13:00 
GeneralRe: SprayableTech: Large-scale interactive surfaces using airbrushed ink Pin
Mark_Wallace12-Apr-20 21:21
MemberMark_Wallace12-Apr-20 21:21 
GeneralRe: SprayableTech: Large-scale interactive surfaces using airbrushed ink Pin
Kris Lantz13-Apr-20 7:56
professionalKris Lantz13-Apr-20 7:56 
NewsApollo 13 in real time Pin
Kent Sharkey12-Apr-20 13:00
staffKent Sharkey12-Apr-20 13:00 
NewsMicrosoft brings 8,000 royalty-free images and icons to Office for Windows users Pin
Kent Sharkey12-Apr-20 13:00
staffKent Sharkey12-Apr-20 13:00 
GeneralRe: Microsoft brings 8,000 royalty-free images and icons to Office for Windows users Pin
Nelek12-Apr-20 23:33
protectorNelek12-Apr-20 23:33 
NewsThis website replicates the sounds of being in the office again Pin
Kent Sharkey12-Apr-20 13:00
staffKent Sharkey12-Apr-20 13:00 
GeneralRe: This website replicates the sounds of being in the office again Pin
Member 798912212-Apr-20 16:02
MemberMember 798912212-Apr-20 16:02 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.