繁体   English   中英

C#开发人员使用什么约定来表明他们的类的作者?

[英]What is the convention C# developers use to indicate their authorship of a class?

我从几个地方读到并了解到C#XML注释中没有作者标签。 但是我敢肯定,遇到这种情况是很常见的,在这种情况下,我们必须使用某些方法来告诉人们特定的课程是由谁和谁编写的。

对于我自己,我正在与几个人一起进行项目,有时了解谁编写了一个班级,它的最后修改日期等有时会很有帮助。

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

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

VB在其中一个极少数情况下,它可以让你创建一个名为VBAxmldoc.xml的文件,这样你就可以为每个关键字自定义模板。 C#没有这个功能,如果你真的有这样做的愿望,并且你没有像我这样的人可以绕过它,你可以创建一个带有doc注释的代码片段,例如Author。 比如创建一个类然后使用它。

我建议使用XML <remarks> 或者,您可以执行大多数开发人员的工作,并在文件顶部创建一个/* ... */块。

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM