Essential C# XML Documentation Comments  Suggest an edit

Method documentation comment with param and returns elements

/// <summary>
/// Returns the data for the specified ID and timestamp.
/// </summary>
/// <param name="id">The ID for which to get data. </param>
/// <param name="time">The DateTime for which to get data. </param>
/// <returns>A DataClass instance with the result. </returns>
public DataClass GetData(int id, DateTime time)
   // ...

IntelliSense shows you the description for each parameter:

Tip: If Intellisense doesn’t display in Visual Studio, delete the first bracket or comma and then type it again.

Table Of Contents
22 Enum
55 XML Documentation Comments
107 Stream
108 Timers
  ↑ ↓ to navigate     ↵ to select     Esc to close