C#文档注释

https://docs.microsoft.com/zh-cn/dotnet/csharp/language-reference/language-specification/documentation-comments#an-example

微软官方文档。

我想补充几点。

1.如果想要所有类或者方法都添加文档注释，而自己总容易忘记添加或者漏添加的话。可以试试这个办法：

在项目上右键--属性--生成--勾选下图所示的选项

如果你没有添加文档注释，将会作为警告显示。

2.如果你有强迫症。(我就有) 觉得警告不过瘾，把它当作错误显示，不添加文档注释就不让编译通过。

那么你可以这样做：

在第一步的基础上。

在项目上右键--属性--生成--勾选下图所示的选项

当然了，你也可以勾所有。(不推荐，因为大多数时候会有很多页面的警告。)

解释一下这三个常用警告：

CS1591:没有<summary>

CS1573:方法中有参数，但是没加参数注释<param> (还有一种是相反的，有<param>，但是没参数--CS1572 这种不常用)

CS1574:cref属性中的类或者符号找不到。(用法：<see cref=""/> 或者 <seealso cref="" />)

3.cref属性里面如果引用泛型类需要这样写<see cref="Product{TItem}" />

如果引用操作符号需要这样写<see cref="operator==" />

 

转载于:https://www.cnblogs.com/grady1028/p/10693703.html