XML Documentation

The familiar commenting symbols // and /* */ allow you to insert comments in the source code to facilitate the reader's understanding of the code. Comments are read in conjunction with the source code. Apart from commenting your code, it is also important to document it. Program documents are, as opposed to source code comments, viewed separately and independently from the source code. A good example of program documentation is the .NET Frameworks class library documentation. Here you can find specific class and struct descriptions, along with descriptions of their members and examples of how to use them; but you won't find any of the underlying source code.

You could set out to write your program documentation as a completely ...

Get C# Primer Plus now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.