[Mono-list] Class Library coding standards

Patrik Torstensson Patrik.Torstensson@framfablabs.com
Thu, 19 Jul 2001 20:59:48 +0200

If we keep it to /// we can use the current C# compiler to get the
documentation out..

Agree that we should keep the comments nice looking also..

- Patrik

-----Original Message-----
From: Miguel de Icaza [mailto:miguel@ximian.com] 
Sent: den 19 juli 2001 20:07
To: Derek Holden
Cc: Sean MacIsaac; mono-list@ximian.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).

// <summary>
//   This is a really nice summary.  It is nice because I wrote it.
//   I wish other summaries were as nice as I am.
// </summary>

ie, .NET SDK (ie, do not like)

// <summary> 
//   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  -  Mono-list@ximian.com