Yorumlar

Açıklamalar iki eğik çizgiyle (//) başlar ve satırın sonuna kadar devam eder. Bu tür satır sonu açıklamaları kaynak kodun herhangi bir yerinde görünebilir. Q# şu anda blok açıklamalarını desteklememektedir.

Belge Açıklamaları

///üç eğik çizgiyle başlayan açıklamalar, bir tür veya çağrılabilen bildirimden önce göründüklerinde derleyici tarafından özel olarak değerlendirilir. Bu durumda, içerikleri diğer .NET dillerinde olduğu gibi tanımlı tür veya çağrılabilir için belge olarak alınır.

/// açıklamalarda, API belgelerinin bir parçası olarak görünecek metinler, belgenin farklı bölümleri özel olarak adlandırılmış üst bilgilerle belirtilen Markdownolarak biçimlendirilir. Markdown uzantısı olarak, Q#'daki işlemlere, işlevlere ve yapı türlerine yönelik çapraz başvurular, <ref target> başvurulmakta olan kod nesnesinin tam adıyla değiştirildiği @"<ref target>," kullanılarak eklenebilir. İsteğe bağlı olarak, belge altyapısı ek Markdown uzantılarını da destekleyebilir.

Örneğin:

/// # 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# aşağıdaki adları belge açıklaması üst bilgileri olarak tanır.

• Özet: bir işlevin veya işlemin davranışının veya türün amacının kısa bir özeti. Özetin ilk paragrafı, vurgulama bilgileri için kullanılır. Düz metin olmalıdır.
• Açıklama: bir işlevin veya işlemin davranışının ya da türün amacının açıklaması. Özet ve açıklama, işlev, işlem veya tür için oluşturulan belge dosyasını oluşturmak üzere birleştirilir. Açıklama, satır içi LaTeX biçimli semboller ve denklemler içerebilir.
• Giriş: bir işlem veya işlev için giriş tanımlama grubunun açıklaması. Giriş tanımlama grubunun her öğesini gösteren ek Markdown alt öğeleri içerebilir.
• Çıktı: bir işlem veya işlev tarafından döndürülen tanımlama grubu açıklaması.
• Tür Parametreleri: Her genel tür parametresi için bir ek alt bölüm içeren boş bir bölüm.
• Adlandırılmış Öğeler: Yapı türündeki adlandırılmış öğelerin açıklaması. Her adlandırılmış öğe için açıklama içeren ek Markdown alt öğeleri içerebilir.
• Örnek: İşlemin, işlevin veya kullanımdaki türün kısa bir örneği.
• Açıklamalar: İşlemin, işlevin veya türün bazı yönlerini açıklayan çeşitli yordamlar.
• Ayrıca Bkz.: İlgili işlevleri, işlemleri veya yapı türlerini gösteren tam adların listesi.
• Başvurular: Belgelenen öğe için başvuru ve alıntıların listesi.