Posted on: 8/20/2013 12:45:10 AM | Views : 270

I've found the <summary> ... </summary> construct above a C# method to be a convenient place to have a full description about a method.  Here's an example of one direct from my code:
/// <summary> /// This is the main Mucking & Tramming version of the original method above. Since it only deals with the movement /// of muck AFTER it is initially broken, many of the fields in MuckData will be zeroed as soon as 2+ items of /// muck are combined. Related to this, we're not going to populate the following fields at all: /// - Equip_Idx /// - Actual_Units /// - Actual_Tons /// - Layout_Units /// - Layout_Tons /// /// We will always set "Index_No" to -1 to indicate that we're no longer using the legacy muck tracking /// mechanism. Instead, we've introduced the 'MuckMoves' table to better track the movement of muck. /// /// Note: We will NOT ...

Go to the complete details ...