CompilationUnitManager.Compilation.NamespaceComments(String, String) Method

Reference

Definition

Namespace:: Microsoft.Quantum.QsCompiler.CompilationBuilder

Assembly:: Microsoft.Quantum.QsCompilationManager.dll

Package:: Microsoft.Quantum.Compiler v0.25.218240

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets non-documentation comments for a namespace.

public Microsoft.Quantum.QsCompiler.SyntaxTree.QsComments NamespaceComments (string sourceFile, string nsName);

member this.NamespaceComments : string * string -> Microsoft.Quantum.QsCompiler.SyntaxTree.QsComments

Public Function NamespaceComments (sourceFile As String, nsName As String) As QsComments

Parameters

sourceFile: String

nsName: String

Returns

QsComments

Remarks

If file sourceFile does not exist in the compilation, or there is not exactly one (partial) namespace nsName, returns a set of empty comments.

Applies to