Como usar o atalho de comentário no código VS

Na codificação, os comentários são uma das poucas maneiras de preservar pensamentos para o futuro. Eles podem ajudá-lo a examinar trechos de código e podem ser úteis para o próximo desenvolvedor que tentará entender o que você escreveu dias antes. Se você estiver usando o Visual Studio Code (VS Code), não há necessidade de digitar incansavelmente delimitadores de comentários todas as vezes. O VS Code possui um recurso de atalho integrado que economiza segundos (e até minutos) do seu tempo.

O atalho de comentário rápido do código VS

Para quem tem pressa, aqui está o seu bilhete dourado:

• Para um comentário de linha única, use a combinação de teclas Ctrl + / no Windows ou Linux ou Cmd + / no Mac.
  ,
• Para um comentário em bloco, use Shift + Alt + A no Windows ou Linux ou Shift + Option + A no Mac.
  ,
• Para comentar o código, você pode pressionar Ctrl + K + C no Windows ou Cmd + K + U no Mac.
  ,

A maioria dos programadores comenta muito. E não se trata apenas de deixar comentários reais, mas talvez o mais importante, você estará comentando e descomentando o código. Isso é viável para testes, experimentações e depuração.

Existem atalhos para tornar isso mais palatável. Eles agilizam a navegação e a alteração, permitindo alternar comentários sem interromper o impulso da codificação.

como obter moedas online

Comentando além do básico

Embora os atalhos básicos sejam um verdadeiro presente, há muito mais para comentar o VS Code. Vamos nos aprofundar:

Alternar comentários

A melhor parte dos atalhos de comentários do VS Code é o recurso de alternância. Você não precisa se preocupar e remover cada marcador de comentário manualmente se mudar de ideia (ou durante a depuração). Em vez disso, você apenas usa os mesmos atalhos. Com as mesmas combinações de teclas, você pode alternar rapidamente entre código comentado e não comentado para se manter organizado quando mais precisar.

Comentando múltiplas linhas

Se você precisar silenciar um longo bloco de código ou deixar um comentário extenso e detalhado, não vai querer perder tempo adicionando arduamente comentários linha por linha. Em vez disso, você pode selecionar as linhas que deseja desativar e usar o atalho de comentários para permitir que o VS Code insira comentários em cada linha.

Comentários aninhados

Às vezes, inserir comentários em um bloco de código pode levar a resultados inesperados e erros se os delimitadores não corresponderem muito bem. É aqui que o Intellisense do Visual Studio Code pode ajudá-lo. Ele ajustará a formatação dos comentários para você, mesmo dentro de um bloco já comentado, para que não haja conflitos com comentários aninhados.

Extensões para comentários sobrecarregadores

VS Code é um editor de código aberto que serve como plataforma para os desenvolvedores apresentarem seus melhores trabalhos de extensão. O mercado está repleto de extensões para oferecer mais poder e utilidade ao comentar:

Melhores comentários

Comentar pode parecer uma parte pequena e opcional da codificação, mas existem muitas maneiras criativas de usar comentários. O Melhores comentários extensão ajuda a adicionar propósito e clareza aos comentários que você espalha, categorizando-os em alertas, consultas, TODOs e outras categorias. E isso tudo com a vantagem adicional do código de cores para melhor visibilidade e organização. Seus comentários tornam-se pontos de orientação e separadores que tornam seu código mais organizado e acessível.

Âncoras de comentários

Âncoras de comentários mantenha você fundamentado em seu código com pontos que distinguem seções ou pontos essenciais dentro dele. Se você tentar esta extensão, ela permitirá que você encontre rapidamente notas e comentários precisos. Se o seu projeto for vasto e seu código estiver ficando lotado e difícil de seguir, isso pode torná-lo muito mais digerível.

código polonês

código polonês transforma seu código e comentários em imagens visualmente interessantes, facilmente legíveis e compartilháveis, perfeitas para mídias sociais. Ele permite redimensionar, codificar por cores, alterar o plano de fundo e muito mais. Você se beneficia de maior legibilidade e qualquer colega de equipe pode colaborar e compartilhar insights com muito mais facilidade.

Por que comentar?

Comentar não é apenas uma caixa para marcar ou alguma tarefa opcional que pessoas prolixas fazem; é parte integrante da codificação. Aqui estão algumas das razões para isso:

como tocar músicas em discórdia

Clareza

Os codificadores procuram tornar inteligível o intratável. Escrever um código que funcione às vezes pode ser mais simples do que escrever um código fácil de entender e seguir. Os comentários são uma bússola para o desenvolvedor – uma ajuda inestimável para navegar por extensões de código, sejam eles leves e jovens ou densos e maduros. Você pode estar lidando com algoritmos complicados ou processos de negócios misteriosos. Em qualquer caso, os comentários fornecem um apoio familiar num mar de complexidade.

Colaboração

Os comentários são úteis quando você é um desenvolvedor solo. Mas eles são necessários ao trabalhar em equipe, se você deseja que seu projeto progrida. Dentro de um esforço colaborativo, os comentários permitem que vários desenvolvedores trabalhem juntos, mesmo quando não estão interagindo. Os membros da equipe explicam o código e compartilham seus processos de pensamento e raciocínio por trás de suas decisões. Isso serve como uma ponte que permite que todos estejam na mesma página tanto com o projeto quanto entre si.

Depuração

Se você estiver revisitando código antigo ou tentando depurar algo que o confunde, os comentários se tornarão sua graça salvadora. Eles mantêm um registro de sua lógica e processo de pensamento anteriores que podem apontar para a possível lógica falha e levá-lo de volta às origens do bug. Com esse lembrete de onde você esteve no passado, você pode reverter alterações problemáticas, otimizar códigos antigos e voltar ao caminho certo.

Dicas para comentários eficazes

Agora você sabe como usar os atalhos de comentários, tem algumas extensões adicionais convenientes e compreende cenários em que comentar é mais útil. Tudo o que resta é considerar algumas práticas recomendadas de comentários e você terá se formado no curso de codificação de comentários.

Ser conciso

Há arte em deixar comentários concisos e de fácil digestão. Deixe apenas o suficiente para dar ao seu futuro eu ou aos membros da sua equipe a ideia certa, mas não tanto a ponto de ser opressor. Cada palavra do seu comentário deve ter um propósito e ajudar a desenvolver a mensagem que você está tentando transmitir. Se o seu comentário for muito breve, ele pode não transmitir a mensagem, mas se for muito longo, é mais provável que você o ignore ou fique confuso com ele no futuro.

Evite comentários óbvios

A relevância deve ser sua principal preocupação na criação de um código claro e compreensível. Se você já escreve seu código de forma que seu significado seja óbvio, não há necessidade de mencionar algo que possa ser visto à primeira vista. Deixe o código falar sempre que puder e use comentários para adicionar contexto extra ou fornecer novas perspectivas.

Use comentários para “Por que” e não “O quê”

Seu código expõe os fatos do que está acontecendo. Mas os comentários podem contar uma história mais profunda. Eles transmitem as motivações e os processos de pensamento por trás de suas decisões. Por que você escolheu esse algoritmo em vez de outro? Quais foram as armadilhas a ter em mente? Talvez você tenha tentado algum código que muitos recomendariam, mas não funcionou ou não teve um bom desempenho. Você pode transmitir muito mais do que meras instruções com comentários bem elaborados.

o que significa recebido no snapchat

Deixando um comentário

O recurso de comentários do VS Code pode ser mais do que uma conveniência. Se você aproveitar ao máximo isso, a diferença na navegabilidade e compreensão de sua base de código pode ser enorme. Complementado com extensões inteligentes e uma estratégia completa, em breve você poderá criar um código bem documentado que parece uma obra-prima.

Você deixa muitos comentários para explicar seu código? Ou você usa comentários principalmente para excluir código quebrado ou experimental do depurador? Conte-nos sua história nos comentários abaixo. Eles estão aqui para ficar.