[Mono-list] XML documentation
Barnette, John
JBarne3@citgo.com
Thu, 18 Oct 2001 11:47:35 -0500
This message is in MIME format. Since your mail reader does not understand
this format, some or all of this message may not be legible.
------_=_NextPart_001_01C157F4.96C0F7B0
Content-Type: text/plain;
charset="ISO-8859-1"
Guys,
This isn't a very important point, but I've noticed some cases of people
using XML documentation snippets like this:
// <summary>
// This class encrypts with ROT13. Twice.
// </summary>
Don't forget, XML documentation comments start with THREE slashes, not two.
/// <summary>
/// ...
/// </summary>
~ j.
The information transmitted is intended only for the person or entity to
which it is addressed and may contain confidential and/or privileged
material. Any review, retransmission, dissemination or other use of, or
taking of any action in reliance upon, this information by persons or
entities other than the intended recipient is prohibited. If you received
this in error, please contact the sender and delete the material from any
computer.
------_=_NextPart_001_01C157F4.96C0F7B0
Content-Type: text/html;
charset="ISO-8859-1"
Content-Transfer-Encoding: quoted-printable
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV=3D"Content-Type" CONTENT=3D"text/html; =
charset=3DISO-8859-1">
<META NAME=3D"Generator" CONTENT=3D"MS Exchange Server version =
5.5.2653.12">
<TITLE>XML documentation</TITLE>
</HEAD>
<BODY>
<P><FONT SIZE=3D2>Guys,</FONT>
</P>
<P><FONT SIZE=3D2>This isn't a very important point, but I've noticed =
some cases of people using XML documentation snippets like this:</FONT>
</P>
<P> <FONT SIZE=3D2>// =
<summary></FONT>
<BR> <FONT =
SIZE=3D2>// This class encrypts with =
ROT13. Twice.</FONT>
<BR> <FONT SIZE=3D2>// =
</summary></FONT>
</P>
<P><FONT SIZE=3D2>Don't forget, XML documentation comments start with =
THREE slashes, not two.</FONT>
</P>
<P> <FONT SIZE=3D2>/// =
<summary></FONT>
<BR> <FONT =
SIZE=3D2>/// ...</FONT>
<BR> <FONT SIZE=3D2>/// =
</summary></FONT>
</P>
<BR>
<P><FONT SIZE=3D2>~ j.</FONT>
<BR><FONT SIZE=3D2>The information transmitted is intended only for the =
person or entity to which it is addressed and may contain confidential =
and/or privileged material. Any review, retransmission, dissemination =
or other use of, or taking of any action in reliance upon, this =
information by persons or entities other than the intended recipient is =
prohibited. If you received this in error, please contact the sender =
and delete the material from any computer.</FONT></P>
</BODY>
</HTML>
------_=_NextPart_001_01C157F4.96C0F7B0--