最新下载
热门教程
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
为自己的类添加说明文字
时间：2022-07-02 18:06:26 编辑：袖梨 来源：一聚教程网
教程
C# 提供一种机制，供开发人员使用 XML 将其代码存档。在源代码文件中，以下代码行可以作为注释处理并放在文件中：以 /// 开始的行；在用户定义的类型（如类、委托或接口）、某成员（如字段、事件、属性或方法）或某命名空间声明之前的行。
示例
下面的示例提供对某个已存档的类型的基本概述。若要编译该示例，请键入以下命令行：
csc XMLsample.cs /doc:XMLsample.xml
这将创建 XML 文件 XMLsample.xml，您可以在浏览器中或使用 TYPE 命令查看该文件。
// XMLsample.cs
// compile with: /doc:XMLsample.xml
using System;
///
/// Class level summary documentation goes here.
///
/// Longer comments can be associated with a type or member
/// through the remarks tag
public class SomeClass
{
///
/// Store for the name property
private string myName = null;
///
/// The class constructor.
public SomeClass()
{
// TODO: Add Constructor Logic here
}
///
/// Name property
///
/// A value tag is used to describe the property value
public string Name
{
get
{
if ( myName == null )
{
throw new Exception("Name is null");
}
return myName;
}
}
///
/// Description for SomeMethod.
/// Parameter description for s goes here
///
/// You can use the cref attribute on any tag to reference a type or member
/// and the compiler will check that the reference exists.
public void SomeMethod(string s)
{
}
C# 提供一种机制，供开发人员使用 XML 将其代码存档。在源代码文件中，以下代码行可以作为注释处理并放在文件中：以 /// 开始的行；在用户定义的类型（如类、委托或接口）、某成员（如字段、事件、属性或方法）或某命名空间声明之前的行。
示例
下面的示例提供对某个已存档的类型的基本概述。若要编译该示例，请键入以下命令行：
csc XMLsample.cs /doc:XMLsample.xml
这将创建 XML 文件 XMLsample.xml，您可以在浏览器中或使用 TYPE 命令查看该文件。
// XMLsample.cs
// compile with: /doc:XMLsample.xml
using System;
///
/// Class level summary documentation goes here.
///
/// Longer comments can be associated with a type or member
/// through the remarks tag
public class SomeClass
{
///
/// Store for the name property
private string myName = null;
///
/// The class constructor.
public SomeClass()
{
// TODO: Add Constructor Logic here
}
///
/// Name property
///
/// A value tag is used to describe the property value
public string Name
{
get
{
if ( myName == null )
{
throw new Exception("Name is null");
}
return myName;
}
}
///
/// Description for SomeMethod.
/// Parameter description for s goes here
///
/// You can use the cref attribute on any tag to reference a type or member
/// and the compiler will check that the reference exists.
public void SomeMethod(string s)
{
}
相关文章
- 《弓箭传说2》新手玩法介绍 01-16
- 《地下城与勇士：起源》断桥烟雨多买多送活动内容一览 01-16
- 《差不多高手》醉拳龙技能特点分享 01-16
- 《鬼谷八荒》毕方尾羽解除限制道具推荐 01-16
- 《地下城与勇士：起源》阿拉德首次迎新春活动内容一览 01-16
- 《差不多高手》情圣技能特点分享 01-16