Opmerkingen

Opmerkingen beginnen met twee slashes (//) en doorgaan tot het einde van de regel. Dergelijke eindopmerkingen kunnen overal in de broncode worden weergegeven. Q# biedt momenteel geen ondersteuning voor blokopmerkingen.

Opmerkingen bij documentatie

Opmerkingen die beginnen met drie slashes, ///worden speciaal behandeld door de compiler wanneer ze worden weergegeven vóór een type of aanroepbare declaratie. In dat geval wordt de inhoud ervan gebruikt als documentatie voor het gedefinieerde type of aanroepbaar, net als voor andere .NET-talen.

In /// opmerkingen wordt tekst die moet worden weergegeven als onderdeel van API-documentatie opgemaakt als Markdown, met verschillende delen van de documentatie die wordt aangegeven door speciaal benoemde headers. Als extensie voor Markdown kunnen kruisverwijzingen naar bewerkingen, functies en door de gebruiker gedefinieerde typen Q# worden opgenomen met behulp van @"<ref target>," waar <ref target> wordt vervangen door de volledig gekwalificeerde naam van het codeobject waarnaar wordt verwezen. Optioneel kan een documentatie-engine ook aanvullende Markdown-extensies ondersteunen.

Bijvoorbeeld:

/// # 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# herkent de volgende namen als kopteksten van documentatieopmerkingen.

• Samenvatting: Een korte samenvatting van het gedrag van een functie of bewerking of het doel van een type. De eerste alinea van de samenvatting wordt gebruikt voor informatie over aanwijzen. Het moet tekst zonder opmaak zijn.
• Beschrijving: Een beschrijving van het gedrag van een functie of bewerking of het doel van een type. De samenvatting en beschrijving worden samengevoegd om het gegenereerde documentatiebestand te vormen voor de functie, bewerking of het type. De beschrijving kan inline LaTeX-opgemaakte symbolen en vergelijkingen bevatten.
• Invoer: Een beschrijving van de invoer tuple voor een bewerking of functie. Kan extra Markdown-subsecties bevatten die elk element van de invoer-tuple aangeven.
• Uitvoer: Een beschrijving van de tuple die wordt geretourneerd door een bewerking of functie.
• Typeparameters: een lege sectie met één extra subsectie voor elke algemene typeparameter.
• Benoemde items: een beschrijving van de benoemde items in een door de gebruiker gedefinieerd type. Kan extra Markdown-subsecties bevatten met de beschrijving voor elk benoemd item.
• Voorbeeld: Een kort voorbeeld van de bewerking, functie of type in gebruik.
• Opmerkingen: Diverse proza's die een bepaald aspect van de bewerking, functie of type beschrijven.
• Zie ook: Een lijst met volledig gekwalificeerde namen die gerelateerde functies, bewerkingen of door de gebruiker gedefinieerde typen aangeven.
• Verwijzingen: Een lijst met verwijzingen en bronvermeldingen voor het gedocumenteerde item.