.net编码规范.docx

文档介绍：C#代码编写规范
注释
类c注释
该类注释用于
1 不再使用的代码。
2 临时测试屏蔽某些代码。
用法
/*
[修改标识]
[修改原因]
. . . (源代码)
*/
常用于文件头部注释,标注出创始人、创始时间、修改人、修改时间、代码的功能等。
例如
/********************************************************************
** 作者: 张三
** 创始时间:2010-9-1
** 修改人:李四
** 修改时间:2010-9-15
** 描述:
** 主要用于产品信息的资料录入,…
*********************************************************************/
单行注释
该类注释用于
1 方法内的代码注释。如变量的声明、代码或代码段的解释。注释示例:
//
// 注释语句
//
private int number;
或
// 注释语句
private int number;
2 方法内变量的声明或花括号后的注释, 注释示例:
if ( 1 == 1) // 总为true
{
statement;
} // 总为true
注释标签

标签
用法
作用
<c>
c>text</c>
text 希望将其指示为代码的文本。
使用<code> 将多行文本标记为代码
<para>
<para>content</para>
content段落文本。
用于诸如<remarks> 或<returns> 等标记内,添加结构到文本中。
<param>
<param name='name'>description</param>
name 为方法参数名。将此名称用单引号括起来(' ')。
应当用于方法声明的注释中,以描述方法的一个参数。
<paramref>
<paramref name="name"/>
name
要引用的参数名。将此名称用双引号括起来(" ")。
<paramref> 标记提供了一种指示词为参数的方法。可以处理 XML 文件,从而用某种独特的方法格式化该参数。
<see>
<see cref="member"/>
cref = "member" 对可以通过当前编译环境进行调用的成员或字段的引用。编译器检查到给定代码元素存在后,将 member 传递给输出 XML 中的元素名。必须将 member 括在双引号(" ") 中。
从文本内指定链接。使用<seealso> 指示希望在“请参阅”一节中出现的文本。
<seealso>
<seealso cref="member"/>
cref = "member" 引用当前编译环境调用的成员或字段。编译器检查到给定代码元素存在后,将 member 传递给输出 XML 中的元素名。必须将 member 括在双引号(" ") 中
指定希望在“请参阅”一节中出现的文本
<example>
<example>description</example>
description
代码示例的说明。
使用<example> 标记可以指定使用方法或其他库的成员的示例。一般情况下,这将涉及到<code> 标记的使用。
<code>
<code>content</code>
content 为希望将其标记为代码的文本。
提供了一种将多行指示为代码的方法。使用<c> 将说明中的文本标记为代码
<summary>
<summary>description</summary>
此处description 为对象的摘要。
应当用于描述类型成员。使用<remarks> 以提供有关类型本身的信息。
<exception>
<exception cref="member">description</exception>
cref = "member" 对可从当前编译环境中获取的异常的引用。编译器检查到给定异常存在后,将
<exception> 标记指定类引发的异常。
member 转换为输出 XML 中的规范化元素名。必须将 member 括在双引号(" ") 中。
description 说明。
<include>
<include file='filename' path='tagpath[***@name="id"]' />
filename 包含文档的文件名。该文件名可用路径加以限定。将 filename 括在单引号中(' ')。
Tagpa