Comentarios

Los comentarios comienzan con dos barras diagonales (//) y continúan hasta el final de la línea. Estos comentarios de fin de línea pueden aparecer en cualquier parte del código fuente. Q# no admite actualmente comentarios en bloque.

Comentarios de documentación

Los comentarios que comienzan con tres barras diagonales, ///, se tratan especialmente mediante el compilador cuando aparecen antes de una declaración de tipo o invocable. En ese caso, su contenido se toma como documentación para el tipo definido o invocable, como para otros lenguajes .NET.

En /// comentarios, el texto que aparece como parte de la documentación de api tiene el formato Markdown, con diferentes partes de la documentación indicadas por encabezados con nombre especial. Como extensión a Markdown, se pueden incluir referencias cruzadas a operaciones, funciones y tipos de estructura en Q# mediante @"<ref target>," donde se reemplaza <ref target> por el nombre completo del objeto de código al que se hace referencia. Opcionalmente, un motor de documentación también puede admitir extensiones adicionales de Markdown.

Por ejemplo:

/// # 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# reconoce los siguientes nombres como encabezados de comentario de documentación.

• Resumen: un breve resumen del comportamiento de una función o operación o el propósito de un tipo. El primer párrafo del resumen se usa para obtener información sobre el puntero. Debe ser texto sin formato.
• Descripción: una descripción del comportamiento de una función o operación o el propósito de un tipo. El resumen y la descripción se concatenan para formar el archivo de documentación generado para la función, la operación o el tipo. La descripción puede contener símbolos y ecuaciones con formato LaTeX en línea.
• entrada: una descripción de la tupla de entrada para una operación o función. Puede contener subsecciones de Markdown adicionales que indican cada elemento de la tupla de entrada.
• salida: una descripción de la tupla devuelta por una operación o función.
• Parámetros de tipo: una sección vacía que contiene una subsección adicional para cada parámetro de tipo genérico.
• Elementos con nombre: una descripción de los elementos con nombre en un tipo de estructura. Puede contener subsecciones adicionales de Markdown con la descripción de cada elemento con nombre.
• Ejemplo: un breve ejemplo de la operación, función o tipo en uso.
• Comentarios: prosas varias que describen algún aspecto de la operación, función o tipo.
• Vea también: una lista de nombres completos que indican funciones, operaciones o tipos de estructura relacionados.
• Referencias: una lista de referencias y citas para el elemento documentado.