次の方法で共有

コメント

コメントは 2 つのスラッシュ (//) で始まり、行末まで続きます。 このような行末コメントは、ソース コード内の任意の場所に表示される場合があります。 Q# は現在、ブロック コメントをサポートしていません。

ドキュメントコメント

3 つのスラッシュ (///) で始まるコメントは、型または呼び出し可能な宣言の前に表示されるときに、コンパイラによって特別に扱われます。 その場合、その内容は、他の .NET 言語と同様に、定義された型または呼び出し可能なドキュメントとして取得されます。

/// コメント内では、API ドキュメントの一部として表示されるテキストは、Markdownとして書式設定され、ドキュメントのさまざまな部分が特別な名前付きヘッダーで示されます。 Markdown の拡張機能として、Q# の操作、関数、構造体の型への相互参照は、<ref target> が参照されているコード オブジェクトの完全修飾名に置き換えられる @"<ref target>," を使用して含めることができます。 必要に応じて、ドキュメント エンジンで追加の Markdown 拡張機能をサポートすることもできます。

次に例を示します。

/// # Summary
/// Given an operation and a target for that operation,
/// applies the given operation twice.
///
/// # Input
/// ## op
/// The operation to be applied.
/// ## target
/// The target to which the operation is to be applied.
///
/// # Type Parameters
/// ## 'T
/// The type expected by the given operation as its input.
///
/// # Example
/// ```Q#
/// // Should be equivalent to the identity.
/// ApplyTwice(H, qubit);
/// ```
///
/// # See Also
/// - Microsoft.Quantum.Intrinsic.H
operation ApplyTwice<'T>(op : ('T => Unit), target : 'T) : Unit {
    op(target);
    op(target);
}

Q# は、次の名前をドキュメント コメント ヘッダーとして認識します。

  • 概要: 関数または操作の動作または型の目的の簡単な概要。 概要の最初の段落は、ホバー情報に使用されます。 プレーン テキストにする必要があります。
  • 説明: 関数または操作の動作または型の目的の説明。 概要と説明が連結され、関数、操作、または型の生成されたドキュメント ファイルが形成されます。 説明には、LaTeX 形式のインライン記号と数式を含めることができます。
  • 入力: 操作または関数の入力タプルの説明。 入力タプルの各要素を示す追加の Markdown サブセクションを含む場合があります。
  • 出力: 操作または関数によって返されるタプルの説明。
  • 型パラメーター: ジェネリック型パラメーターごとに 1 つの追加サブセクションを含む空のセクション。
  • 名前付きアイテム: 構造体型の名前付きアイテムの説明。 各名前付きアイテムの説明を含む追加の Markdown サブセクションを含む場合があります。
  • 例: 使用されている操作、関数、または型の簡単な例です。
  • 備考: 操作、関数、または型の一部の側面を説明するその他の散文。
  • 関連する関数、操作、または構造体の型を示す完全修飾名の一覧も参照してください。
  • 参照: 文書化された項目の参照と引用の一覧。
  • Last updated on