의견

주석은 두 개의 슬래시(//)로 시작하고 줄이 끝날 때까지 계속됩니다. 이러한 줄 끝 주석은 소스 코드의 아무 곳에나 나타날 수 있습니다. Q#에서는 현재 블록 주석을 지원하지 않습니다.

설명서 주석

세 개의 슬래시 ///로 시작하는 주석은 형식 또는 호출 가능한 선언 앞에 표시될 때 컴파일러에서 특별히 처리합니다. 이 경우 해당 콘텐츠는 다른 .NET 언어와 마찬가지로 정의된 형식 또는 호출 가능한 형식에 대한 설명서로 사용됩니다.

/// 주석 내에서 API 설명서의 일부로 표시할 텍스트는 Markdown 형식으로 지정되며, 설명서의 다른 부분은 특별히 명명된 헤더로 표시됩니다. Markdown의 확장으로, @"<ref target>,"를 사용하여 Q#의 연산, 함수, 사용자 정의 형식에 대한 상호 참조를 포함할 수 있습니다. 여기서 <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 하위 섹션을 포함할 수 있습니다.
• 출력: 작업 또는 함수가 반환한 튜플의 설명입니다.
• 형식 매개 변수: 각 제네릭 형식 매개 변수에 대해 하나의 추가 하위 섹션이 포함된 빈 섹션입니다.
• 명명된 항목: 사용자 정의 형식의 명명된 항목에 대한 설명입니다. 명명된 각 항목에 대한 설명과 함께 추가 Markdown 하위 섹션을 포함할 수 있습니다.
• 예: 사용 중인 작업, 함수 또는 형식의 간단한 예입니다.
• 설명: 연산, 함수 또는 형식의 일부 측면을 설명하는 기타 산문입니다.
• 참고 항목: 관련 함수, 작업 또는 사용자 정의 형식을 나타내는 정규화된 이름 목록입니다.
• 참조: 문서화된 항목에 대한 참조 및 인용 목록입니다.