Visual Studio 2010 SP1 is now ready to be downloaded! MSDN subscribers can download it with their account, while others will have to wait until Thursday, March 10 to get it.
Happy updating!
Update: Here is the download link
C# 5.0: Asynchronous Programming
For those who are not aware, you can download the Visual Studio Async CTP to get a preview of what is coming in the asynchronous world! This is just the CTP version, so there may be changes between this version and the official release.
Also, visit Eric Lippert’s blog to learn more about the topic.
Reference Documentation
In the November edition of MSDN Magazine, Peter Gruenbaum explains how to write good reference documentation for APIs in his article titled “A Coder’s Guide to Writing API Documentation”.
My attention was particularly drawn to Figures 2 and 3, which explain how to comment while maintaining consistency throughout the API. I have reproduced them here:
Figure 2: Reference Documentation Style
| Type | Guideline | Examples |
|---|---|---|
| Class | Start with a word like “Represents” | “Represents a user’s photo album.” |
| Methods and functions | Start with a verb | “Returns the number of contacts for the specified area.” “Pauses the video.” |
| Properties | Use a noun or start with verbs such as “Gets” or “Gets and sets” | “The user’s tasks.” “Gets and sets a collection of the user’s tasks.” |
| Events | Start with a phrase such as “Raised when” or “Occurs when” | “Raised when the response from server is received.” |
| XML elements | Use a noun-based phrase | “The city’s postal code.” |
| Boolean values | For Boolean properties, start with “Indicates whether”; for Boolean return values on methods and functions, start with “Returns whether” | “Indicates whether the control is visible.” “Returns whether two regions intersect.” |
Figure 3: Reference Documentation Example
[Read More]