100162749.htm
来自「C#高级编程(第三版),顶死你们。。 。up」· HTM 代码 · 共 284 行 · 第 1/3 页
HTM
284 行
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><title>
2.12 使用注释
</title></head>
<body>
<div class="area">
<div class="col1">
<div class="lineBlue">
</div>
<!-- title -->
<div class="arcTitle">
<h1>
<a href="../16">
C#高级编程（第3版）【全文连载】
</a>
</h1>
<div style="text-align: center; font-size: 15px">
<a href="100162749.htm">
2.12 使用注释
</a>
</div>
<div style="text-align: center; font-size: 15px">
<a class="url" href="../../default.htm">http://book.csdn.net/</a>
2006-8-17 16:57:00
</div>
<div style="margin: 0px auto; width: 700px; border: solid 1px #0b5f98;">
<div style="float: left; width: 16px; background-color: #0b5f98; color: White; padding: 1px;">
图书导读
</div>
<div style="float: right; width: 670px; text-align: left; line-height: 16pt; padding-left: 2px">
<!--导读-->
<h1 id="divCurrentNode" style="color: #b83507; width: 100%; text-align: left; font-size: 12px; padding-left: 2px">当前章节:<a href='100162749.htm'><font color='red'>2.12 使用注释</font></a></h1>
<div id="divRelateNode" style="padding-left: 2px">
<div style='float:left;width:49%'>·<a href='100162746.htm'>2.9 Main()方法</a></div><div style='float:right;width:49%'>·<a href='100162747.htm'>2.10 有关编译C#文件的更多内容</a></div><div style='float:left;width:49%'>·<a href='100162748.htm'>2.11 控制台I/O</a></div><div style='float:right;width:49%'>·<a href='100162750.htm'>2.13 C#预处理器指令</a></div><div style='float:left;width:49%'>·<a href='100162751.htm'>2.14 C#编程规则</a></div><div style='float:right;width:49%'>·<a href='100162752.htm'>2.15 小结</a></div></div>
</div>
</div>
</div>
<!-- main -->
<div id="main">
<div id="text"> <link href="css.css" rel="stylesheet" type="text/css" /><p class="MsoNormal"><span><span style="FONT-FAMILY: 宋体">本节的内容表面上看起来很简单<span style="LETTER-SPACING: -0.5pt">——</span>给代码添加注释。</span></span></p>
<h3 style="MARGIN: 8.15pt 0cm"><span lang="EN-US">2.12.1 </span><span style="FONT-FAMILY: 黑体">源文件中的内部注释</span></h3>
<p class="MsoNormal"><span style="FONT-FAMILY: 宋体">在本章开头提到过，</span><span lang="EN-US">C#</span><span style="FONT-FAMILY: 宋体">使用传统的</span><span lang="EN-US">C</span><span style="FONT-FAMILY: 宋体">风格注释方式：单行注释使用</span><span lang="EN-US">// <sup>...</sup></span><span style="FONT-FAMILY: 宋体">，多行注释使用</span><span lang="EN-US"> /* <sup>...</sup> */</span><span style="FONT-FAMILY: 宋体">：</span></p>
<p class="2" style="MARGIN: 8.15pt 0cm 0pt 21.45pt; TEXT-INDENT: 18.45pt"><span lang="EN-US">// This is a single-line comment</span></p>
<p class="2" style="MARGIN-LEFT: 21.45pt; TEXT-INDENT: 18.45pt"><span lang="EN-US">/* This comment</span></p>
<p class="2" style="MARGIN: 0cm 0cm 8.15pt 21.45pt; TEXT-INDENT: 18.45pt"><span lang="EN-US"> spans multiple lines */</span></p>
<p class="MsoNormal"><span style="FONT-FAMILY: 宋体">单行注释中的任何内容，即</span><span lang="EN-US">//</span><span style="FONT-FAMILY: 宋体">后面的内容都会被编译器忽略。多行注释中</span><span lang="EN-US">/* </span><span style="FONT-FAMILY: 宋体">和</span><span lang="EN-US"> */</span><span style="FONT-FAMILY: 宋体">之间的所有内容也会被忽略。显然不能在多行注释中包含</span><span lang="EN-US">*/</span><span style="FONT-FAMILY: 宋体">组合，因为这会被当作注释的结尾。</span></p>
<p class="MsoNormal"><span style="FONT-FAMILY: 宋体">实际上，可以把多行注释放在一行代码中：</span></p>
<p class="2" style="MARGIN: 8.15pt 0cm 8.15pt 21.45pt; TEXT-INDENT: 18.45pt"><span lang="EN-US">Console.WriteLine(/*Here's a comment! */ "This will compile");</span></p>
<p class="MsoNormal"><span style="FONT-FAMILY: 宋体">像这样的内联注释在使用时应小心，因为它们会使代码难以理解。但这样的注释在调试时是非常有用的，例如，在运行代码时要临时使用另一个值：</span></p>
<p class="2" style="MARGIN: 8.15pt 0cm 8.15pt 21.45pt; TEXT-INDENT: 18.45pt"><span lang="EN-US">DoSomething(Width, /*Height*/ 100);</span></p>
<p class="MsoNormal"><span style="FONT-FAMILY: 宋体">当然，字符串字面值中的注释字符会按照一般的字符来处理：</span></p>
<p class="2" style="MARGIN: 8.15pt 0cm 8.15pt 21.45pt; TEXT-INDENT: 18.45pt"><span lang="EN-US">string s = "/* This is just a normal string */";</span></p>
<h3 style="MARGIN: 8.15pt 0cm"><span><span lang="EN-US">2.12.2 XML</span></span><span style="FONT-FAMILY: 黑体">文档说明</span></h3>
<p class="MsoNormal"><span><span style="FONT-FAMILY: 宋体">如前所述，除了</span><span lang="EN-US">C</span></span><span style="FONT-FAMILY: 宋体">风格的注释外，</span><span lang="EN-US">C#</span><span style="FONT-FAMILY: 宋体">还有一个非常好的功能，本章将讨论这一功能。根据特定的注释自动创建</span><span lang="EN-US">XML</span><span style="FONT-FAMILY: 宋体">格式的文档说明。这些注释都是单行注释，但都以</span><span lang="EN-US">3</span><span style="FONT-FAMILY: 宋体">个斜杠</span><span lang="EN-US">(///)</span><span style="FONT-FAMILY: 宋体">开头，而不是通常的两个斜杠。在这些注释中，可以把包含类型和类型成员的文档说明的</span><span lang="EN-US">XML</span><span style="FONT-FAMILY: 宋体">标识符放在代码中。</span></p>
<p class="MsoNormal"><span style="FONT-FAMILY: 宋体">编译器可以识别表</span><span lang="EN-US">2-15</span><span style="FONT-FAMILY: 宋体">中所示的标识符。</span></p>
<p class="a5" style="MARGIN-TOP: 8.15pt"><span style="FONT-FAMILY: 黑体">表</span><span lang="EN-US"> 2-15</span></p>
<div align="center">
<table class="MsoNormalTable" style="BORDER-RIGHT: medium none; BORDER-TOP: medium none; BORDER-LEFT: medium none; WIDTH: 436.65pt; BORDER-BOTTOM: medium none; BORDER-COLLAPSE: collapse" cellspacing="0" cellpadding="0" width="582" border="1">
<tbody>
<tr>
<td style="BORDER-RIGHT: windowtext 1pt solid; PADDING-RIGHT: 9.9pt; BORDER-TOP: windowtext 1pt solid; PADDING-LEFT: 9.9pt; PADDING-BOTTOM: 1.4pt; BORDER-LEFT: medium none; WIDTH: 3cm; PADDING-TOP: 1.4pt; BORDER-BOTTOM: windowtext 1pt solid" valign="top" width="113">
<p class="a2"><span style="FONT-FAMILY: 黑体">标</span><span style="FONT-FAMILY: 'Times New Roman'"> </span><span style="FONT-FAMILY: 黑体">识</span><span style="FONT-FAMILY: 'Times New Roman'"> </span><span style="FONT-FAMILY: 黑体">符</span></p>
</td>
<td style="BORDER-RIGHT: medium none; PADDING-RIGHT: 9.9pt; BORDER-TOP: windowtext 1pt solid; PADDING-LEFT: 9.9pt; PADDING-BOTTOM: 1.4pt; BORDER-LEFT: medium none; WIDTH: 351.6pt; PADDING-TOP: 1.4pt; BORDER-BOTTOM: windowtext 1pt solid" valign="top" width="469">
<p class="a2"><span style="FONT-FAMILY: 黑体">说</span><span lang="EN-US" style="FONT-FAMILY: 'Times New Roman'"> </span><span style="FONT-FAMILY: 黑体">明</span></p>
</td>
</tr>
<tr>
<td style="BORDER-RIGHT: windowtext 1pt solid; PADDING-RIGHT: 9.9pt; BORDER-TOP: medium none; PADDING-LEFT: 9.9pt; PADDING-BOTTOM: 1.4pt; BORDER-LEFT: medium none; WIDTH: 3cm; PADDING-TOP: 1.4pt; BORDER-BOTTOM: windowtext 1pt solid" valign="top" width="113">
<p class="a4" style="MARGIN-LEFT: 10.7pt"><span lang="EN-US"><c></span></p>
</td>
<td style="BORDER-RIGHT: medium none; PADDING-RIGHT: 9.9pt; BORDER-TOP: medium none; PADDING-LEFT: 9.9pt; PADDING-BOTTOM: 1.4pt; BORDER-LEFT: medium none; WIDTH: 351.6pt; PADDING-TOP: 1.4pt; BORDER-BOTTOM: windowtext 1pt solid" valign="top" width="469">
<p class="a4" style="MARGIN-LEFT: 10.7pt"><span style="FONT-FAMILY: 宋体">把行中的文本标记为代码，例如</span><span lang="EN-US"><c>int i = 10;</c></span></p>
</td>
</tr>
<tr>
<td style="BORDER-RIGHT: windowtext 1pt solid; PADDING-RIGHT: 9.9pt; BORDER-TOP: medium none; PADDING-LEFT: 9.9pt; PADDING-BOTTOM: 1.4pt; BORDER-LEFT: medium none; WIDTH: 3cm; PADDING-TOP: 1.4pt; BORDER-BOTTOM: windowtext 1pt solid" valign="top" width="113">
<p class="a4" style="MARGIN-LEFT: 10.7pt"><span lang="EN-US"><code></span></p>
</td>
<td style="BORDER-RIGHT: medium none; PADDING-RIGHT: 9.9pt; BORDER-TOP: medium none; PADDING-LEFT: 9.9pt; PADDING-BOTTOM: 1.4pt; BORDER-LEFT: medium none; WIDTH: 351.6pt; PADDING-TOP: 1.4pt; BORDER-BOTTOM: windowtext 1pt solid" valign="top" width="469">
<p class="a4" style="MARGIN-LEFT: 10.7pt"><span style="FONT-FAMILY: 宋体">把多行标记为代码</span></p>
</td>
</tr>
<tr>
<td style="BORDER-RIGHT: windowtext 1pt solid; PADDING-RIGHT: 9.9pt; BORDER-TOP: medium none; PADDING-LEFT: 9.9pt; PADDING-BOTTOM: 1.4pt; BORDER-LEFT: medium none; WIDTH: 3cm; PADDING-TOP: 1.4pt; BORDER-BOTTOM: windowtext 1pt solid" valign="top" width="113">
<p class="a4" style="MARGIN-LEFT: 10.7pt"><span lang="EN-US"><example></span></p>
</td>
<td style="BORDER-RIGHT: medium none; PADDING-RIGHT: 9.9pt; BORDER-TOP: medium none; PADDING-LEFT: 9.9pt; PADDING-BOTTOM: 1.4pt; BORDER-LEFT: medium none; WIDTH: 351.6pt; PADDING-TOP: 1.4pt; BORDER-BOTTOM: windowtext 1pt solid" valign="top" width="469">
⌨️ 快捷键说明
复制代码Ctrl + C
搜索代码Ctrl + F
全屏模式F11
增大字号Ctrl + =
减小字号Ctrl + -
显示快捷键?