注释代码

注释不仅仅应当说明代码会执行什么操作，还应当注明原因。例如，不要仅仅在注释中说明是在遍历数组，而是要说明遍历数组是根据某一算法计算一个值，除非算法是相当简单的，否则还应当对算法进行简要的说明。

.NET工程中的不同的编程语言都有各自不同的注释符号，下面是一个简要的说明：

HTML    <!-- 注释 -->

JavaScript和C#     单行注释   //    多行注释     多行注释  /*  */

SQL   单行注释   --       多行注释     多行注释  /*  */

在服务器控件的开始和结束标记中没有注释符号，但服务器能够忽略掉所有它不能识别的属性，因此我们能够通过使用没有定义的属性来插入注释。下面是一个例子：

<asp:TextBox

id="txtLastName"

size="40"

comment="这是我的注释"

runat="server" />

在Visual Studio .NET中对源代码进行注释非常简单。高亮度显示需要注释的行，然后按Ctrl+K+C组合键添加注释。要删除注释，只需高亮度显示被注释的代码，并按下Ctrl+K+U组合键。

在C#工程中，我们还可以通过在每行的开始处使用///输入XML注释小节。在注释小节中，我们可以使用下面的XML标记组织注释：

<summary></summary>

<remarks></remarks >

<param></param>

<returns></returns>

<newpara></newpara>

要在Visual Studio .NET中查看这些XML注释的格式化的报告，我们可以首先选择“工具”菜单项，然后选择“建立注释Web网页”菜单项。