Welcome to MSDN Blogs Sign in | Join | Help

A Polite Request for Those Who Post Code

Lots of samples flying around - I think we released new versions of just about everything we publish in the last twelve months, so everyone is publishing all kinds of tutorials and how-tos online.

In observation of this, I have one simple request - if you're going to post sample code, please be sure to include any references you add to the project and the using statements from the head of the file. Thanks. :)

Philo

Published Sunday, April 18, 2004 11:02 PM by philoj

Comments

Tuesday, April 20, 2004 1:23 PM by Patrick

# re: A Polite Request for Those Who Post Code

While we're at it, here are some more reasonable requests:

- use decent variable names, avoiding the "this.button5 syndrome"
- adhere to some kind of consistent standard, even if it's Madman LuNaTiCase (syallabic capitalization with word-shared letters dropped)
- would it kill you to leave in your pseudocode or sprinkle in a couple of explanatory comments (ex. why is the private Graphics member declared volatile)?
- please take out unused stubs:
/// <summary>
/// Summary description for Form1.
/// </summary>

- try to leave in whitespace formatting when you can.

Patrick
New Comments to this post are disabled
 
Page view tracker