Referência: Extensão do Microsoft Quantum Development Kit para Visual Studio Code

O Microsoft Quantum Development Kit (QDK) usa a funcionalidade padrão de Visual Studio Code (VS Code), juntamente com recursos específicos do idioma quando você trabalha com arquivos .qs ou .qasm. Este guia de referência descreve todos os comandos do QDK que você pode acessar na Paleta de Comandos do VS Code, juntamente com outros recursos e links para conteúdo adicional. Para obter diretrizes gerais do VS Code, consulte a documentação do VS Code.

Dica

A maioria dos comandos da extensão QDK está acessível no menu Exibir > Paleta de Comandos . Enquanto estiver em um .qs ou .qasm arquivo, abra a Paleta de Comandos e digite QDK: para exibir uma lista filtrada de comandos.

Commands

A maioria dos comandos do QDK está relacionada à gravação e execução de programas Q# e OpenQASM e só estão disponíveis quando um arquivo .qs ou um arquivo .qasm está ativo. Outros comandos funcionam em segundo plano e não estão acessíveis na Paleta de Comandos.

A tabela a seguir descreve os comandos da extensão QDK que aparecem na Paleta de Comandos.

Dica

Você pode criar atalhos de teclado personalizados para comandos do VS Code usando atalhos de teclado ou Ctrl + K + S. Para obter mais informações, consulte Key Bindings for VS Code.

Command	Action	Observações	Ação alternativa do usuário
QDK: Criar projeto Q#	Cria um projeto Q# na pasta ativa, incluindo um qsharp.json arquivo de manifesto e uma src subpasta com um arquivo padrão main.qs .	Para obter mais informações sobre projetos Q#, consulte Trabalhando com projetos Q#.	No Explorador de Arquivos, clique com o botão direito do mouse na pasta de destino e selecione Criar projeto Q#.
QDK: Criar um notebook Quantum da Microsoft	Abre um Jupyter Notebook de exemplo que executa um programa Q# + Python e envia um trabalho para o Azure Quantum.	Para obter mais informações sobre o QDK no Jupyter Notebook, consulte Submitir trabalhos para Azure Quantum de Jupyter Notebook.	N/A
QDK: Conectar-se a um workspace do Azure Quantum	Conecte-se a um workspace do Azure Quantum usando sua conta do Azure ou uma cadeia de conexão. Depois de autenticado, seu workspace aparecerá no Explorador de Arquivos no Quantum Workspaces.	Para obter mais informações sobre conexões do Azure Quantum, consulte Conectar-se ao workspace do Azure Quantum.	No Explorador de Arquivos, passe o mouse sobre os workspaces do Quantum e selecione o ícone +.
QDK: Abra o playground do QDK	Abre uma pasta online de programas de exemplo de Q# e OpenQASM no Explorador de Arquivos. Você pode editar e executar os programas no simulador quântico local e também definir pontos de interrupção e percorrer o código com o depurador interno.	Para obter mais informações, consulte o arquivo README na pasta de exemplo.	N/A
QDK: Atualizar espaços de trabalho do Azure Quantum	Sincroniza as alterações mais recentes de seus espaços de trabalho quânticos conectados.	Se houver um problema de conexão, um ícone de alerta será exibido ao lado do nome do workspace.	No Explorador de Arquivos, passe o mouse sobre Quantum Workspaces e selecione o ícone de atualização.
Explorer: Foco em Visualização de Workspaces Quânticos	Abre o Explorador de Arquivos e se concentra nas suas áreas de trabalho quânticas conectadas, se elas estiverem configuradas. Se nenhum workspace estiver configurado, você será solicitado a adicionar um workspace existente.	Para obter mais informações sobre conexões do Azure Quantum, consulte Conectar-se ao workspace do Azure Quantum.	N/A

Os seguintes comandos estão disponíveis quando um arquivo .qs ou .qasm está ativo.

Command	Action	Observações	Ação alternativa do usuário
QDK: Mostrar circuito	Exibe um diagrama de circuito para o programa antes de ser executado.	Para obter mais informações, consulte Visualizar diagramas de circuitos quânticos.	Selecione a opção Code Lens Circuit no menu ao lado da operação do ponto de entrada ou acima de cada operação definida pelo usuário no programa.
QDK: Executar arquivo e mostrar histograma	Executa o programa atual e exibe um histograma dos resultados em um novo painel.	Para acessar as opções de classificação e filtro para a exibição de histograma, selecione o ícone de filtro no painel de histograma.	Selecione a opção Code Lens Histograma no menu ao lado da operação do ponto de entrada.
QDK: Obter QIR para o programa QDK atual	Abre a fonte QIR para o código Q# ou OpenQASM atual em uma nova janela de edição. Seu programa deve usar o perfil de destino Base, RI Adaptável ou RIF Adaptável para exportar a origem do QIR.	Para obter mais informações sobre QIR, consulte a representação intermediária do Quantum e o blog do desenvolvedor do QDK.	N/A
QDK: calcular estimativas de recursos	Invoca a versão interna do avaliador de recursos.	Para obter mais informações, consulte Introdução ao avaliador de recursos do Microsoft Quantum.	N/A
QDK: Ajuda	Uma breve visão geral da extensão QDK no VS Code.	Para obter a documentação completa do Microsoft Quantum, consulte a documentação do Microsoft Quantum.	N/A
QDK: Executar arquivo e mostrar diagrama de circuito	Executa o programa atual e exibe um circuito do programa com saídas.	Para obter mais informações, consulte Visualizar diagramas de circuitos quânticos.	N/A
QDK: Mostrar documentação da API	Abre a documentação da API em um novo painel. Para pesquisar esse painel, pressione Ctrl + F.	Para obter mais informações, consulte a referência da API Microsoft Quantum.	N/A
QDK: Mostrar o Changelog	Abre um registro de alterações em uma nova guia que mostra as atualizações do QDK para a versão atual e todas as versões anteriores.	O registro de alterações também está disponível no repositório GitHub do QDK de código aberto.	N/A
Depuração: Iniciar Depuração	Abre o programa atual no depurador.	Para obter mais informações, consulte Depuração e teste de seu código quântico.	Pressione F5 ou selecione a opção de lente de código Depurar no menu ao lado da operação do ponto de entrada ou selecione o ícone Executar no canto superior direito e escolha Iniciar Depuração.
Depuração: Executar	Executa o programa atual no simulador quântico padrão.	Para obter mais informações, consulte Introdução aos programas Q#.	Pressione Ctrl + F5 ou selecione a opção de lente de código Executar no menu ao lado da operação do ponto de entrada ou selecione o ícone Executar no canto superior direito e escolha Executar.

Terminais

Os programas Q# e OpenQASM usam duas janelas de terminal no VS Code:

Terminal	Action
Console de depuração	Exibe a saída de execução ou a saída de depuração
Problemas	Exibe verificações de erro de pré-compilação

Editar código Q# e OpenQASM

A maioria dos recursos comuns de edição de código no VS Code também estão disponíveis quando você trabalha com programas Q# e OpenQASM:

• Verificação de erros de pré-compilação
• Ir para definição
• References
• Assinaturas de função
• Informação de parâmetro
• Sugestões de conclusão, incluindo reconhecimento de contexto, membro do namespace e preenchimentos de membro de tipo.
• Linting – em arquivos Q#, você configura o linting por projeto no arquivo de manifesto. Para obter mais informações, consulte Trabalhando com projetos Q#.

Para obter mais informações, consulte Intellisense na documentação do VS Code.

Tarefas comuns

Trabalhar com arquivos e projetos do Q#

Tarefa	Action	Observações
Novo arquivo Q#	Selecione Arquivo > Novo arquivo > Arquivo de texto. Salve o arquivo com uma .qs extensão.	Se você definir Files: Default Language = qsharp, um novo arquivo usará automaticamente a formatação em Q#.
Criar um projeto Q#	Em uma pasta aberta no Explorador de Arquivos, selecione Criar Projeto Q# na Paleta de Comandos ou clique com o botão direito do mouse na pasta no Explorador de Arquivos e selecione Criar projeto Q#.	Para obter mais informações sobre projetos Q#, consulte Trabalhando com projetos Q#.
Ficheiros de exemplo	Em um arquivo .qs em branco .qasm, insira amostras e escolha um programa de amostra na lista de opções.	Você também pode selecionar Abrir o playground do QDK na Paleta de Comandos para abrir uma pasta online de programas de exemplo de Q# e OpenQASM no Explorador de Arquivos.

Conectar-se ao Azure Quantum

Tarefa	Action	Observações	Ação alternativa do usuário
Conectar a um espaço de trabalho do Azure Quantum	No Explorador de Arquivos, Quantum Workspaces e selecione Adicionar um Workspace Existente. Siga os prompts para selecionar uma assinatura e um workspace.	Você pode se conectar a vários espaços de trabalho. Selecione + ao lado de Quantum Workspaces para conectar outro espaço de trabalho. As conexões do workspace persistem entre as sessões do VS Code.	Na Paleta de Comandos, selecione QDK: Conectar-se a um workspace do Azure Quantum.
Conecte-se programaticamente com um programa Python	Clique com o botão direito do mouse em uma conexão de workspace existente e selecione Copiar código Python para se conectar ao workspace. Cole o código resultante em seu programa Python.	Para obter mais informações, consulte Enviando trabalhos do Python com Q# para o Azure Quantum.	N/A

Executar programas

Tarefa	Action	Observações	Ação alternativa do usuário
Executar um programa Q# ou OpenQASM no simulador quântico local	Em um arquivo .qs ou arquivo .qasm, selecione Executar no canto superior direito e então selecione Executar.	Para obter mais informações sobre o simulador quântico, consulte o simulador quântico esparso.	Pressione Ctrl + F5 ou escolha QDK: Executar arquivo e mostrar histograma ou QDK: Executar arquivo e mostrar diagrama de circuito na Paleta de Comandos ou escolher a opção Executar lente de código acima da operação do ponto de entrada.
Depurar um programa	Em um programa Q# ou OpenQASM, selecione o ícone Executar no canto superior direito e escolha Iniciar Depuração.	Para obter mais informações sobre o depurador Q# no VS Code, consulte Depurando e testando seu código quântico.	Pressione F5 ou escolha a lente de código 'Debug' no menu acima da operação de entrada.
Exibir provedores e alvos em suas áreas de trabalho	No Explorador de Arquivos, selecione Quantum Workspaces, expanda o workspace e, então, expanda Provedores para ver os provedores disponíveis no workspace. Expanda um provedor individual para exibir os destinos disponíveis.	Passe o mouse sobre um nome de destino para exibir seu status e tempo de fila antes de enviar um trabalho.	N/A
Enviar um trabalho para o Azure Quantum	Em um programa Q# ou OpenQASM, escolha um workspace, um provedor e um destino. Para enviar o programa atual, selecione a seta ao lado do destino.	Para obter mais informações, consulte Enviando trabalhos Q# para o Azure Quantum.	N/A
Exibir resultados do trabalho	Expanda o espaço de trabalho e depois expanda Jobs. Para abrir a saída do trabalho do Armazenamento do Azure, selecione o ícone de nuvem ao lado do nome do trabalho.	Os trabalhos são listados do mais novo para o mais antigo.	N/A