Click here to Skip to main content
15,901,373 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!

 
QuestionThe frustrated architect Pin
Rajeev Jayaram27-Mar-12 0:51
Rajeev Jayaram27-Mar-12 0:51 
AnswerRe: The frustrated architect Pin
Vivi Chellappa27-Mar-12 16:06
professionalVivi Chellappa27-Mar-12 16:06 
NewsWhy Javascript is a Joy Pin
Terrence Dorsey26-Mar-12 10:57
sitebuilderTerrence Dorsey26-Mar-12 10:57 
GeneralWhy Javascript is a horror Pin
Clifford Nelson26-Mar-12 16:20
Clifford Nelson26-Mar-12 16:20 
NewsPL101: Create your own programming language Pin
Terrence Dorsey26-Mar-12 10:56
sitebuilderTerrence Dorsey26-Mar-12 10:56 
NewsFunctional Fizz Buzz Pin
Terrence Dorsey26-Mar-12 10:55
sitebuilderTerrence Dorsey26-Mar-12 10:55 
News10 Best Practices of Code Commenting & Formatting Pin
Terrence Dorsey26-Mar-12 10:55
sitebuilderTerrence Dorsey26-Mar-12 10:55 
GeneralRe: 10 Best Practices of Code Commenting & Formatting Pin
Chris Maunder27-Mar-12 4:37
cofounderChris Maunder27-Mar-12 4:37 
Quote:
Don't write uncorrect comments

11. Ensure grammar and spelling are correct.

I think it's time to stop with the pithy "only comment when required" with the example
int count = 0; // assigning zero as initial value to the count

I think we all get that.

How about "Always add a comment that adds to the understanding of what's happening, and never assume your reader understands the full context. Ensure any ambiguity in your choice of object name is clarified".

I see things like "CreateObject", which seems obvious, but is it creating it in-memory, or creating it and persisting it?
cheers,
Chris Maunder

The Code Project | Co-founder
Microsoft C++ MVP

GeneralRe: 10 Best Practices of Code Commenting & Formatting Pin
AspDotNetDev27-Mar-12 13:24
protectorAspDotNetDev27-Mar-12 13:24 
NewsHow to make your build faster Pin
Terrence Dorsey26-Mar-12 10:54
sitebuilderTerrence Dorsey26-Mar-12 10:54 
NewsCracking the cloud: An Amazon Web Services primer Pin
Terrence Dorsey26-Mar-12 10:54
sitebuilderTerrence Dorsey26-Mar-12 10:54 
NewsHow a web application can download and store over 2GB without you even knowing it Pin
Terrence Dorsey26-Mar-12 10:53
sitebuilderTerrence Dorsey26-Mar-12 10:53 
NewsA Computer Program to Detect Possible Cheating in Chess Pin
Terrence Dorsey26-Mar-12 10:53
sitebuilderTerrence Dorsey26-Mar-12 10:53 
NewsAre You Really Sure You Want to Make a Cancel Button? Pin
Terrence Dorsey26-Mar-12 10:52
sitebuilderTerrence Dorsey26-Mar-12 10:52 
NewsTron bike game in 219 bytes of JavaScript Pin
Terrence Dorsey26-Mar-12 10:52
sitebuilderTerrence Dorsey26-Mar-12 10:52 
GeneralRe: Tron bike game in 219 bytes of JavaScript Pin
Chris Maunder27-Mar-12 4:41
cofounderChris Maunder27-Mar-12 4:41 
NewsBraceless Programming Pin
Terrence Dorsey25-Mar-12 10:27
sitebuilderTerrence Dorsey25-Mar-12 10:27 
GeneralRe: Braceless Programming Pin
PIEBALDconsult25-Mar-12 15:32
mvePIEBALDconsult25-Mar-12 15:32 
GeneralRe: Braceless Programming Pin
Vivi Chellappa25-Mar-12 18:46
professionalVivi Chellappa25-Mar-12 18:46 
GeneralRe: Braceless Programming Pin
PIEBALDconsult26-Mar-12 3:36
mvePIEBALDconsult26-Mar-12 3:36 
NewsThe Differences Between Development on Windows Azure and Windows Server Pin
Terrence Dorsey25-Mar-12 10:26
sitebuilderTerrence Dorsey25-Mar-12 10:26 
JokeRe: The Differences Between Development on Windows Azure and Windows Server Pin
Karthik_Rockzzz26-Mar-12 2:24
Karthik_Rockzzz26-Mar-12 2:24 
NewsJavaScript's Two Zeros Pin
Terrence Dorsey25-Mar-12 10:25
sitebuilderTerrence Dorsey25-Mar-12 10:25 
NewsJava Tuning in a Nutshell Pin
Terrence Dorsey25-Mar-12 10:25
sitebuilderTerrence Dorsey25-Mar-12 10:25 
NewsSam's ultimate web performance tool and resource list Pin
Terrence Dorsey25-Mar-12 10:24
sitebuilderTerrence Dorsey25-Mar-12 10:24 

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.