mo.notono.us

Sunday, January 28, 2007

Generics and XML Comments - how to

XML Comments don't like generics that much. Here's how to document a generic type - currently, at least:
XML doc comments and C#'s generic syntax don't mix. In order to help work around this, we allow you to use {}'s in place of <>'s when referring to generic types in crefs. So, imagine the following code:
/// 
/// This class implements 
/// 
class Example : IComparable
{
     // implementation of IComparable    
}
From https://connect.microsoft.com/VisualStudio/feedback/ViewFeedback.aspx?FeedbackID=91982

Labels: ,

0 Comments:

Post a Comment

Links to this post:

Create a Link

<< Home