发一份微软官方的代码注释示例

下面的示例列出一个 Point 类的源代码注释：


namespace Graphics




...{






/**//// <summary>Class <c>Point</c> models a point in a two-dimensional plane.


/// </summary>


public class Point




...{




/**//// <summary>Instance variable <c>x</c> represents the point's


/// x-coordinate.</summary>


private int x;




/**//// <summary>Instance variable <c>y</c> represents the point's


/// y-coordinate.</summary>


private int y;




/**//// <value>Property <c>X</c> represents the point's x-coordinate.</value>


public int X




...{




get ...{ return x; }




set ...{ x = value; }


}




/**//// <value>Property <c>Y</c> represents the point's y-coordinate.</value>


public int Y




...{




get ...{ return y; }




set ...{ y = value; }


}




/**//// <summary>This constructor initializes the new Point to


/// (0,0).</summary>




public Point() : this(0,0) ...{}




/**//// <summary>This constructor initializes the new Point to


/// (<paramref name="xor"/>,<paramref name="yor"/>).</summary>


/// <param><c>xor</c> is the new Point's x-coordinate.</param>


/// <param><c>yor</c> is the new Point's y-coordinate.</param>




public Point(int xor, int yor) ...{


X = xor;


Y = yor;


}




/**//// <summary>This method changes the point's location to


/// the given coordinates.</summary>


/// <param><c>xor</c> is the new x-coordinate.</param>


/// <param><c>yor</c> is the new y-coordinate.</param>


/// <see cref="Translate"/>




public void Move(int xor, int yor) ...{


X = xor;


Y = yor;


}



出自--<<C#语言规范1.2版>>