Skip to Main Content
Visual Studio Hacks
book

Visual Studio Hacks

by James Avery
March 2005
Intermediate to advanced content levelIntermediate to advanced
304 pages
19h 23m
English
O'Reilly Media, Inc.
Content preview from Visual Studio Hacks
272
|
Chapter 8, Comments and Documentation
#68 Master C# XML Comments
HACK
The hacks in this chapter will cover how to get the most out of XML com-
ments, how to create comments faster using an add-in, how to create docu-
mentation from your comments, how to use XML comments with VB.NET,
and how to integrate your own documentation into Visual Studio.
HACK
#68
Master C# XML Comments Hack #68
Comment your code with a sprinkling of XML, and give IntelliSense and
documentation tools plenty of grist for their mills.
XML comments are a compelling addition to any project. Using XML com-
ments, you can document all of your public classes, methods, and enumera-
tions while you program. The basics of XML comments are very simple—
precede your comments with
///, and Visual Studio will add a basic sum-
mary and an element for each of the parameters on your method. You can
then enter the summary and parameter descriptions. But there is much more
to XML comments; there are 20 different tags that can be used in XML com-
ments. In this hack, you are going to learn how to use all of these tags to cre-
ate better documentation.
To insert XML comments, simply type
/// on a line preceding a class, inter-
face, method, field, or property declaration. As soon as you type these char-
acters, IntelliSense will give you a skeletal XML comment with an empty
<summary> element:
/// <summary>
///
/// </summary>
public void Foo( )
Technically ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Start your free trial

You might also like

Microsoft Visual Studio 2015 Unleashed, Third Edition

Microsoft Visual Studio 2015 Unleashed, Third Edition

Mike Snell, Lars Powers
.Net Framework Essentials

.Net Framework Essentials

Thuan L. Thai, Hoang Lam
C# 5.0 Unleashed

C# 5.0 Unleashed

Bart De Smet
Programming .NET Security

Programming .NET Security

Adam Freeman, Allen Jones

Publisher Resources

ISBN: 0596008473Errata Page