c# – 我可以使用ReSharper来执行评论标准吗？

发布时间：2020-12-15 06:50:27 所属栏目：百科来源：网络整理

导读：最近与ReSharper玩了很多,有一件事我想为我的团队设置是通知,如果C#类或C#文件没有设置代码注释标准.不幸的是,我还没有找到很多的话题. 例如,我想确保所有的方法或函数都有上面的注释描述： /// summary/// Description of MyMethod here./// /summarypublic

最近与ReSharper玩了很多,有一件事我想为我的团队设置是通知,如果C#类或C#文件没有设置代码注释标准.不幸的是,我还没有找到很多的话题.

例如,我想确保所有的方法或函数都有上面的注释描述：

/// <summary>
/// Description of MyMethod here.
/// </summary>
public void MyMethod();

我也想看一下,是否(代码行数)/(评论行数)的基本检查是围绕一些神奇的快乐媒体,如果没有,则会创建通知或警告.

解决方法

开始(一个甚至不需要R#)的一个简单的选项是打开XML文档文件的生成,然后将警告视为错误.这将确保每个公共成员都有文件.

当然不会保证这些评论是好的,但它会确保它们存在.

编辑：R#确实有一个设置 – 在代码检查,检查严重性,C#,编译器警告,寻找CS1591：缺少XML注释公开可见的类型或成员(以及附近的相关警告).将其严重性更改为错误,它可能会帮助您 – 但是,当您处于不寻常的环境时,很难说.

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!