在c＃中评论

Question

我有一个简单的问题。我是c＃的新手，我想知道是否将作者放在.cs类中。到目前为止，我已经看到只有摘要和标题注释放在那里。

Answer 1

这里确实没有正确或错误的答案 - 这取决于公司政策/您的偏好。但是，在我看来，没有必要出于两个原因：

• 源代码管理会告诉您此信息
• 多个开发人员可以参与任何一个文件的开发

Answer 2

使用源代码控制系统时，将作者作为评论完全无关紧要。源控制系统可以帮助您为每一行做出最新更改的人。

如果您没有使用源代码管理或在网络上发布代码，则评论可能是合适的。

Answer 3

如果代码库是共享的，那么就没有像单个作者那样的东西了。如果您有任何源代码管理，则会将每个编辑信息与用户关联起来。这是一个更好的方法，比在顶部有作者姓名，并在他/她触摸该文件时附加每个作者姓名。

Answer 4

我想说，如果您发布代码，并且编写了代码，可能会有某些更新，您可以将其作为作者，并添加更新/更正/错误修复的注释。

如果它是内部的，这不应该是必要的，因为源控制将处理这一点，而在内部，尝试说“这是我的”不太重要。