C#完全学习手册-02--C#注释
1.
//注释内容
2.
/*注释内容*/
3.XML注释功能(参考:http://www.cnblogs.com/beyoung/archive/2007/07/22/827521.html)
使用特殊的注释语法(///)开头。在///之后,你可以使用预先定义的标签注释你的代码,也可以插入你自己定义的标签。如:
/// <summary>
///
/// </summary>
最常用的组合示例:
/// <summary>
/// 按指定汉字长度截取字符串并加上...
/// </summary>
/// <param name="str">要截取的字符串</param>
/// <param name="length">截取汉字长度</param>
/// <param name="isRounLastChar">当结尾存在半个汉字时是否保留</param>
/// <returns>截取后的结果</returns>
public string CutString4(string str, int length, bool isRounLastChar)
{
}作用:在调用该方法是会弹出你加上的注释,这样写代码时就更容易理解该方法的用处。
示例代码:
using System;
![](/Images/OutliningIndicators/None.gif)
namespace HelloWorld
{
/// <summary>
/// Sample Hello World in C#
/// </summary>
public class HelloWorld
{
/// <summary>
/// 函数作用的描述
/// <param name="args">Command Line Arguments</param>
/// <returns>Status code of 0 on successful run</returns>
/// </summary>
public static int Main(string[] args)
{
System.Console.WriteLine("HelloWorld");
string name = System.Console.ReadLine();
![](/Images/OutliningIndicators/InBlock.gif)
return(0);
}
}
}
//注释内容
2.
/*注释内容*/
3.XML注释功能(参考:http://www.cnblogs.com/beyoung/archive/2007/07/22/827521.html)
使用特殊的注释语法(///)开头。在///之后,你可以使用预先定义的标签注释你的代码,也可以插入你自己定义的标签。如:
![](/Images/OutliningIndicators/ExpandedBlockStart.gif)
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/InBlock.gif)
预定义的标签 | 用处 |
<c> | 将说明中的文本标记为代码 |
<code> | 提供了一种将多行指示为代码的方法 |
<example> | 指定使用方法或其他库成员的示例 |
<exception> | 允许你指定可能发生的异常类 |
<include> | 允许你引用描述源代码中类型和成员的另一文件中的注释, 使用 XML XPath 语法来描述你的源代码中的类型和成员。 |
<list> | 向XML注释文档中插入一个列表 |
<para> | 向XML注释文档中插入一个段落 |
<param> | 描述一个参数 |
<paramref> | 提供了一种指示一个词为参数的方法 |
<permission> | 允许你将成员的访问许可加入到文档中 |
<remarks> | 用于添加有关某个类型的信息 |
<returns> | 描述返回值 |
<see> | 指定链接 |
<seealso> | 指定希望在“请参见”一节中出现的文本 |
<summary> | 类型或类型成员的通用描述 |
<value> | 描述属性 |
最常用的组合示例:
![](/Images/OutliningIndicators/ExpandedBlockStart.gif)
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/ExpandedBlockEnd.gif)
![](/Images/OutliningIndicators/None.gif)
![](/Images/OutliningIndicators/ExpandedBlockStart.gif)
![](/Images/OutliningIndicators/ExpandedBlockEnd.gif)
示例代码:
![](/Images/OutliningIndicators/None.gif)
![](/Images/OutliningIndicators/None.gif)
![](/Images/OutliningIndicators/None.gif)
![](/Images/OutliningIndicators/ExpandedBlockStart.gif)
![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/ExpandedSubBlockEnd.gif)
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/ExpandedSubBlockEnd.gif)
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/ExpandedSubBlockEnd.gif)
![](/Images/OutliningIndicators/ExpandedSubBlockEnd.gif)
![](/Images/OutliningIndicators/ExpandedBlockEnd.gif)
![](/Images/OutliningIndicators/None.gif)
posted on 2007-08-07 11:38 JEEF WANG 阅读(2213) 评论(0) 编辑 收藏 举报