c# - C# 开发人员用来表示他们的类作者身份的约定是什么？

Question

我从几个地方阅读并了解到 C# XML 注释中没有作者标记。但我敢肯定，经常会遇到这样的情况，我们必须使用一些方法来告诉人们某个特定的课程是由谁和谁编写的。

就我自己而言，我正在与几个人一起做一个项目，有时知道谁写了一个类、它的最后修改日期等会很有帮助。

在 Java 中，有一个@author, @modified, 等参数用于生成文档的注释。我是 C# 新手。由于 XML 注释中没有作者标记，当 C# 开发人员想要指示某个类是由他们编写的时，他们使用的约定是什么？

Answer 1

很少有专业的 C# 程序员在没有源代码管理的情况下工作，如果您使用源代码管理，“作者”或“修改”标签是完全没有意义的；因此，没有关于这个问题的公约。

Answer 2

VB 在极少数情况下最好让您创建一个名为 VBAxmldoc.xml 的文件，这样您就可以实际为每个关键字自定义模板。C# 没有这个功能，如果你真的很想这样做，并且没有像我这样的人，你可以创建一个包含文档注释的代码片段，例如 Author。比如说创建一个类然后使用它。

Answer 3

我建议使用 XML <remarks>。或者您可以做大多数开发人员所做的事情，并/* ... */在文件顶部创建一个块。