C# Language Specification - Willy .Net

Appendix E Documentation CommentsE.2.6 This tag is for use inside other tags, such as (§E.2.10) or (§E.2.11), and permitsstructure to be added to text.Syntax:wherecontentcontentExample:The text of the paragraph./// This is the entry point of the Point class testing program./// This program tests each method and operator, and/// is intended to be run after any non-trvial maintenance has/// been performed on the Point class.public static void Main() {// …}E.2.7 This tag is used to describe a parameter for a method, constructor, or indexer.Syntax:descriptionwherenameThe name of the parameter.descriptionA description of the parameter.Example:/// This method changes the point's location to/// the given coordinates./// xor is the new x-coordinate./// yor is the new y-coordinate.public void Move(int xor, int yor) {X = xor;Y = yor;}E.2.8 This tag is used to indicate that a word is a parameter. The documentation file can be processed to format thisparameter in some distinct way.Syntax:wherenameThe name of the parameter.Example:437