C#笔记:XML文档注释

本文介绍了在Visual C#中如何使用XML标记为代码创建文档注释,通过实例展示了注释的编写方法及其作用,有助于提高代码的可读性和维护效率。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

一、介绍

在 Visual C# 中,可以通过以下方法为代码创建文档:紧接在源代码中 XML 标记引用的代码块的前面,使用特殊的注释字段包括 XML 标记。 例如:

/// <summary>
///  This class performs an important function.
/// </summary>
public class MyClass{}

二、示例

实例1:

/// <summary>
/// 增加方法
/// </summary>
/// <param name="sql"></param>
/// <returns>受影响行数</returns>
public int Select(string sql)
{
conn.Open();
comm = new SqlCommand(sql,conn);
int row = comm.ExecuteNonQuery();
return row;
}

实例2:

/// <summary>
/// 增加
/// </summary>
/// <param name="us"></param>
/// <returns>受影响行数</returns>
public int Return(users us)
{
string sql = string.Format("insert into a(name,age) values('{0}','{1}')", us.name, us.age);
int row = Select(sql);//在调用Select的时候,可以看见注释,表明这个方法有什么用
return row;
} 

三、操作方式

先写好函数或方法,然后在函数或方法的上一行输入“///”后,系统会自动出来…以及参数等,在补全说明即可。

四、作用

注释,在编写代码较多时,比如类、方法等等,能更快更效率的知道它们的作用。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

视觉闫小亘

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值