在c＃中评论

Question

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

Answer 1

这里确实没有正确或错误的答案 - 这归结于公司政策/您的偏好。在我看来，不过，这是不必要的，原因有二：

• 源控制告诉你这些信息
• 不止一个开发者可以在任何一个文件

Answer 2

的发展涉及使用一个源代码管理系统，把作者作为评论是完全不相干的。源代码管理系统可以帮助您将最新更改的人员分配给每一行。

如果您不使用源代码控制或在网上发布代码，评论可能是合适的。

Answer 3

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

Answer 4

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

如果它的内部，这不应该是必要的，因为源代码控制会照顾到这一点，而在内部它不太重要，试图说“这是我的”。