[Mono-list] Class Library coding standards
Thu, 19 Jul 2001 20:59:48 +0200
If we keep it to /// we can use the current C# compiler to get the
Agree that we should keep the comments nice looking also..
From: Miguel de Icaza [mailto:firstname.lastname@example.org]
Sent: den 19 juli 2001 20:07
To: Derek Holden
Cc: Sean MacIsaac; email@example.com
Subject: Re: [Mono-list] Class Library coding standards
> While we're all talking about this, is anyone XML doc commenting their
> code? Should we be, or is that going to be done by someone who works
> on documenting for the SDK docs? If we should now, is there a format
> we should stick to?
I like more the XML-style than the SDK style.
ie, XML (ie, I like more).
// This is a really nice summary. It is nice because I wrote it.
// I wish other summaries were as nice as I am.
ie, .NET SDK (ie, do not like)
// I am an ugly looking summary</summary> <return-value>god, what do
// I return?</return-value>
I am exagearating a bit, but you get the idea.
Mono-list maillist - Monofirstname.lastname@example.org