13.07.2015 Views

C# Language Specification - Willy .Net

C# Language Specification - Willy .Net

C# Language Specification - Willy .Net

SHOW MORE
SHOW LESS

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

<strong>C#</strong> LANGUAGE SPECIFICATIONE.2.14 This tag can be used to describe a member for a type. (Use (§E.2.10) to describe the type itself.)Syntax:descriptionwheredescriptionA summary of the member.Example:/// This constructor initializes the new Point to (0,0).public Point() : this(0,0) {}E.2.15 This tag allows a property to be described.Syntax:property descriptionwhereproperty descriptionA description for the property.Example:/// Property X represents the point's x-coordinate.public int X{get { return x; }}set { x = value; }E.3 Processing the documentation fileThe following information is intended for <strong>C#</strong> implementations targeting the CLI.The documentation generator generates an ID string for each element in the source code that is tagged with adocumentation comment. This ID string uniquely identifies a source element. A documentation viewer can use anID string to identify the corresponding metadata/reflection item to which the documentation applies.The documentation file is not a hierarchical representation of the source code; rather, it is a flat list with agenerated ID string for each element.E.3.1 ID string formatThe documentation generator observes the following rules when it generates the ID strings:• No white space is placed in the string.• The first part of the string identifies the kind of member being documented, via a single character followedby a colon. The following kinds of members are defined:440

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!