c# - 私有字段中的 C# 注释

Question

可能重复：
我应该记录我的私有方法吗？

为私有字段和私有方法写评论是一种好习惯吗？我写了一个简单的库，我真的不知道是否为我的私人字段添加评论。

Answer 1

如果您有相关的内容要说，最好将其记录下来，即使是私人成员，作为未来维护课程的指导方针。但是像“获取或设置 Foo 属性”这样的样板注释对于私有代码 IMO 来说是纯粹的噪音。