如何记录在C＃中XML的作者？ [英] How to document the author in C# XML?

问题描述

在href=\"http://msdn.microsoft.com/en-us/library/5ast78ax.aspx\">建议标签是，我惊讶的是，没有作者标记

In the list of recommended tags is, for my surprise, no author tag. So I am wondering, what is the 'official' or 'best practice' way to document the author of class/method?

推荐答案

我觉得这个想法是，我们已经在使用基于团队的工作源头控制，因此标志着笔者从内部的角度来看毫无意义的，因为我们已经知道了作者，时间，做出改变，等于是你或许应该坚持使用这个。在某些环境下是可以接受离开的个性块在你的注释。

I think the idea is that we already use source control for team-based work, so marking the author is pointless from the internal perspective because we already know the author, the time, changes made, and etc. So you should probably stick with this. In some environments it is acceptable to leave chunks of personality in your comments.

从外部的角度来看，我不会觉得它很重要谁在每个项目的基础上编写的文件。否则，使用类似维基第三方文档工具。

From the external perspective I wouldn't think it matters who writes the documentation on a per item basis. Otherwise use a third party documentation tool like a wiki.

某些源控制工具，将让你做出模板，例如物像的许可，作者，修改日期等，可要在正规的意见顶部自动插入。

Some source control tools will allow you to make templates such that things like licenses, authors, modified date, etc. can be inserted automatically at the top in regular comments.

这篇关于如何记录在C＃中XML的作者？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！