Blocos de Código em Markdown

Blocos de código são essenciais para documentação técnica, tutoriais e qualquer conteúdo que inclui exemplos de código. O Markdown fornece várias maneiras de formatar código, desde trechos simples inline até blocos de código completos com destaque de sintaxe.

Código Inline

Para trechos curtos de código dentro de frases, use crases únicas:

Use o comando `git status` para verificar seu repositório.
A função `console.log()` imprime no console.
Pressione `Ctrl+C` para parar o processo.

Resultado:

Use o comando git status para verificar seu repositório. A função console.log() imprime no console. Pressione Ctrl+C para parar o processo.

Blocos de Código Cercados

Para código de múltiplas linhas, use três crases:

```
function greet(name) {
  console.log("Olá, " + name + "!");
}

greet("Mundo");
```

Resultado:

function greet(name) {
  console.log("Olá, " + name + "!");
}

greet("Mundo");

Destaque de Sintaxe

Adicione o nome da linguagem após as crases de abertura para destaque de sintaxe:

JavaScript

```javascript
function calculateSum(a, b) {
  return a + b;
}

const result = calculateSum(5, 3);
console.log(result); // Output: 8
```

Python

```python
def calculate_sum(a, b):
    return a + b

result = calculate_sum(5, 3)
print(result)  # Output: 8
```

Identificadores de Linguagem Populares

Linguagem	Identificador	Alternativo
JavaScript	javascript	js
Python	python	py
Java	java
C++	cpp	c++
C#	csharp	cs
HTML	html
CSS	css
SQL	sql
JSON	json
XML	xml
Shell	bash	sh
TypeScript	typescript	ts
React JSX	jsx
PHP	php
Go	go
Rust	rust
Swift	swift

Notas Importantes

Blocos de código cercados são o método preferido para formatar código em Markdown, pois fornecem melhor destaque de sintaxe e são mais amplamente suportados em diferentes plataformas.

Melhores Práticas

1. Sempre Use Destaque de Sintaxe

❌ Sem destaque de sintaxe:

```
if (user.isLoggedIn) {
  showDashboard();
} else {
  showLoginForm();
}
```

✅ Com destaque de sintaxe:

```javascript
if (user.isLoggedIn) {
  showDashboard();
} else {
  showLoginForm();
}
```

2. Mantenha Exemplos de Código Focados

❌ Muito código irrelevante:

```javascript
// Muito código de configuração...
const express = require('express');
const app = express();
const PORT = 3000;

// ... mais configuração ...

// O exemplo real (perdido na configuração)
app.get('/api/users', (req, res) => {
  res.json({ users: [] });
});

// ... mais código padrão ...
```

✅ Focado na parte importante:

```javascript
// Criar um endpoint de API simples
app.get('/api/users', (req, res) => {
  res.json({ users: [] });
});
```

Casos de Uso Comuns

Documentação de API

Requisição:

POST /api/users
Content-Type: application/json

{
  "name": "João Silva",
  "email": "[email protected]"
}

Resposta:

{
  "id": 123,
  "name": "João Silva",
  "email": "[email protected]",
  "created_at": "2024-01-15T10:30:00Z"
}

Arquivos de Configuração

Crie um arquivo .env na raiz do seu projeto:

# Configuração do banco de dados
DB_HOST=localhost
DB_PORT=5432
DB_NAME=meuapp
DB_USER=postgres
DB_PASSWORD=senha123

# Chaves da API
API_KEY=sua_chave_api_aqui
SECRET_KEY=sua_chave_secreta_aqui

Solução de Problemas

Problemas Comuns

1. Código não formata: Verifique as crases adequadas
2. Destaque de sintaxe não funciona: Verifique o identificador de linguagem
3. Código quebra layout: Use quebras de linha adequadas

Escapando Crases

Se você precisar mostrar crases em seu código:

Exemplo de crase única:

• •
  Escreva: `código`
• •
  Resultado: código

Exemplo de três crases:

• •
  Escreva: ```bloco de código```
• •
  Resultado: bloco de código

Crases em código inline:

• •
  Escreva: ``crase``
• •
  Resultado: crase

Blocos de código são essenciais para documentação técnica. Use-os para tornar seus exemplos de código claros, legíveis e adequadamente formatados!

Finalmente, vamos aprender sobre quebras de linha para aperfeiçoar sua formatação de texto.