xml comments - author tag?

N

Niki Estner

Hi there,

In my experience, even in the worst-commented files, at least the author of
classes/methods are documented, like:

// Written by NES - 15.02.03
void Something()
{
... [1000 lines of code without a single comment]
int i;
i = 0; // inserted by XYZ - 19.03.03
... [ no more comments in the remaining 2000 loc]

Why isn't there an <author> tag in the C# XML-comment syntax?
Is there any standard for commenting authorship?
(I've looked at NDoc, but they simply don't comment who did what)

Thank you for any suggestions

Niki
 
N

Nicholas Paldino [.NET/C# MVP]

Niki,

Unfortunately, there is no standard tag for an author (and I agree that
one should be there). You might want to consider embedding your own xml
(that conforms to a schema possibly) in the comments. If you embed other
XML, it will be output to the XML comments document as well. After that,
you have to recognize it and do something with it when you process it later.

Hope this helps.
 

Ask a Question

Want to reply to this thread or ask your own question?

You'll need to choose a username for the site, which only take a couple of moments. After that, you can post your question and our members will help you out.

Ask a Question

Top