DocComment.Example Property

Reference

Definition

Namespace:: Microsoft.Quantum.QsCompiler.Documentation

Assembly:: Microsoft.Quantum.QsDocumentationParser.dll

Package:: Microsoft.Quantum.Compiler v0.25.218240

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Caution

Please use Examples instead.

All examples of using the named item, concatenated as a single Markdown document.

[System.Obsolete("Please use Examples instead.")]
public string Example { get; }

[<System.Obsolete("Please use Examples instead.")>]
member this.Example : string

Public ReadOnly Property Example As String

Property Value

String

Attributes: ObsoleteAttribute

Applies to