Table of Contents
docfx-pages

Automatic HeaderDoc Extraction

Tests/Program.cs   HeaderDoc

This document is written in KDoc Style. Generic block comment style is also allowed.

HeaderDoc must be placed at beginning of file and starting with /* or /**. If no HeaderDoc closer (*/) found, whole document is ignored.

Note

HeaderDoc closer must be placed in separated line and starting with * followed by /, no space between * and / is allowed. You can insert additional single space before asterisk. When 2 or more spaces exists, it is not treated as HeaderDoc closer.

Heading

Markdown heading.

Another Heading

Markdown heading 2.

Sub Heading

Markdown sub heading.

Another Sub Heading

Markdown sub heading 2.

One Last Heading

Markdown triple # heading.

// this comment line must be retained
Double_Slash_at_Line_Start_must_be_Remain_Untouched();

public class CSharp
{
    public void Test()
    {
        //...
    }
}

List test in *-starting line. spaces must be preserved.

  • 1st
    • 2nd
  • 3rd
    • 4th
      • 5th

End of document.

Edit this page