Background

July 2, 2026 ยท View on GitHub

Conceptual pages (How To)

(This is conceptual documentation that will go to learn.microsoft.com "how to" page)

Examples

(This is conceptual documentation that will go to learn.microsoft.com "how to" page)

API Pages

(Each of the following L2 sections correspond to a page that will be on learn.microsoft.com)

MyExample class

Brief description of this class.

Introduction to one or more example usages of a MyExample class:

void SampleMethod() 
{
  var show = new MyExample();
  show.SomeMembers = AndWhyItMight(be, interesting)
}

Remarks about the MyExample class. For example, APIs should only throw exceptions in exceptional conditions; basically, only when there's a bug in the caller, such as argument exception. But if for some reason it's necessary for a caller to catch an exception from an API, call that out with an explanation either here or in the Examples

MyExample.PropertyOne property

Brief description of the MyExample.PropertyOne property.

Paragraph with more detail about the property.

Spec note: internal comment about this property that won't go into the public docs.

Introduction to one or more usages of the MyExample.PropertyOne property.

...

Other MyExample members

NameDescription
PropertyTwoBrief description of the PropertyTwo property (defaults to ...)
MethodOneBrief description of the MethodOne method

API Details

namespace Microsoft.Name.Space
{
  runtimeclass MyExample
  {
      Int32 PropertyOne;
      String PropertyTwo { get; }
      void MethodOne();

       /// Brief description of the MethodTwo method
      void MethodTwo();
  }
}

Appendix