c#如何使用XML文档功能-创新互联

c#如何使用 XML 文档功能？很多新手对此不是很清楚，为了帮助大家解决这个难题，下面小编将为大家详细讲解，有这方面需求的人可以来学习下，希望你能有所收获。

示例

// If compiling from the command line, compile with: -doc:YourFileName.xml

/// 

/// Class level summary documentation goes here.
/// 
/// 
/// Longer comments can be associated with a type or member through
/// the remarks tag.
/// 
public class TestClass : TestInterface
{
  /// 

  /// Store for the Name property.
  /// 
  private string _name = null;

  /// 

  /// The class constructor.
  /// 
  public TestClass()
  {
    // TODO: Add Constructor Logic here.
  }

  /// 

  /// Name property.
  /// 
  /// 
  /// A value tag is used to describe the property value.
  /// 
  public string Name
  {
    get
    {
      if (_name == null)
      {
        throw new System.Exception("Name is null");
      }
      return _name;
    }
  }

  /// 

  /// Description for SomeMethod.
  /// 
  ///  Parameter description for s goes here.
  /// 
  /// You can use the cref attribute on any tag to reference a type or member
  /// and the compiler will check that the reference exists.
  /// 
  public void SomeMethod(string s)
  {
  }

  /// 

  /// Some other method.
  /// 
  /// 
  /// Return values are described through the returns tag.
  /// 
  /// 
  /// Notice the use of the cref attribute to reference a specific method.
  /// 
  public int SomeOtherMethod()
  {
    return 0;
  }

  public int InterfaceMethod(int n)
  {
    return n * n;
  }

  /// 

  /// The entry point for the application.
  /// 
  ///  A list of command line arguments.
  static int Main(System.String[] args)
  {
    // TODO: Add code to start application here.
    return 0;
  }
}

/// 

/// Documentation that describes the interface goes here.
/// 
/// 
/// Details about the interface go here.
/// 
interface TestInterface
{
  /// 

  /// Documentation that describes the method goes here.
  /// 
  /// 
  /// Parameter n requires an integer argument.
  /// 
  /// 
  /// The method returns an integer.
  /// 
  int InterfaceMethod(int n);
}