最近从校园进入了职场,发现项目中的好多注释都是这样写的:
/// <summary>
/// 叽里呱啦
/// </summary>
而在学校时写小项目的时候注释一般都用这样的格式:
//叽里呱啦
在网上查了查资料之后发现/// <summary>这种注释方式更加适合多人协作开发,类似于“使用说明”。
举个例子:
//这是一个自定义函数Function1
public void Function1(int testA,bool testB)
{
}
/// <summary>
/// 这是一个自定义函数Function2
/// </summary>
/// <param name="testA">请输入整数型参数</param>
/// <param name="testB">请输入布尔型参数</param>
public void Function2(int testA, bool testB)
{
}
在调用Function1函数时显示:

在调用Function2函数时显示:

函数的语句提示可以让使用者更加清楚的函数的定义与使用方式。
总的来说/// <summary>的注释方式为使用注释(帮助使用),//的注释方式为开发注释(辅助开发)


文章讲述了从校园进入职场后,在项目开发中遇到的不同注释风格,尤其是///<summary>与//的区别。///<summary>格式的注释更适合多人协作,提供函数使用说明,而//通常用于辅助个人开发。通过对比Function1和Function2两个函数的注释,强调了函数参数提示在代码理解和使用上的帮助作用。

1073

被折叠的 条评论
为什么被折叠?



