[Mono-list] Class Library coding standards

Derek Holden dholden@draper.com
Thu, 19 Jul 2001 09:58:11 -0400

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?

The .NET Framework SDK seems to do

/// <tag> \n
/// text</tag> \n

For instance

/// <summary>
/// Get the answer to the Ultimate Quesiton.</summary>
/// <param name="question">
/// The question to be asked</param>
/// <returns>
/// The answer 42</returns>
public int GetAnswer(string question)
        return 42;