Блоки кода в Markdown

Блоки кода необходимы для технической документации, учебных пособий и любого контента, включающего примеры кода. Markdown предоставляет несколько способов форматирования кода, от простого встроенного кода до полных блоков кода с подсветкой синтаксиса.

Встроенный код

Для коротких фрагментов кода внутри предложений используйте одинарные обратные кавычки:

Используйте команду `git status` для проверки вашего репозитория.
Функция `console.log()` выводит в консоль.
Нажмите `Ctrl+C` для остановки процесса.

Результат:

Используйте команду git status для проверки вашего репозитория. Функция console.log() выводит в консоль. Нажмите Ctrl+C для остановки процесса.

Огражденные блоки кода

Для многострочного кода используйте тройные обратные кавычки:

```
function greet(name) {
  console.log("Привет, " + name + "!");
}

greet("Мир");
```

Результат:

function greet(name) {
  console.log("Привет, " + name + "!");
}

greet("Мир");

Подсветка синтаксиса

Добавьте название языка после открывающих обратных кавычек для подсветки синтаксиса:

JavaScript

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

const result = calculateSum(5, 3);
console.log(result); // Вывод: 8
```

Python

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

result = calculate_sum(5, 3)
print(result)  # Вывод: 8
```

Популярные идентификаторы языков

Язык	Идентификатор	Альтернативный
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

Важные заметки

Огражденные блоки кода являются предпочтительным методом для форматирования кода в Markdown, поскольку они обеспечивают лучшую подсветку синтаксиса и более широко поддерживаются на разных платформах.

Лучшие практики

1. Всегда используйте подсветку синтаксиса

❌ Без подсветки синтаксиса:

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

✅ С подсветкой синтаксиса:

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

2. Сохраняйте примеры кода сфокусированными

❌ Слишком много нерелевантного кода:

```javascript
// Много кода настройки...
const express = require('express');
const app = express();
const PORT = 3000;

// ... больше настройки ...

// Реальный пример (спрятан в настройке)
app.get('/api/users', (req, res) => {
  res.json({ users: [] });
});

// ... больше шаблонного кода ...
```

✅ Сфокусировано на важной части:

```javascript
// Создание простой API конечной точки
app.get('/api/users', (req, res) => {
  res.json({ users: [] });
});
```

Распространенные случаи использования

Документация API

Запрос:

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

{
  "name": "Иван Петров",
  "email": "[email protected]"
}

Ответ:

{
  "id": 123,
  "name": "Иван Петров",
  "email": "[email protected]",
  "created_at": "2024-01-15T10:30:00Z"
}

Файлы конфигурации

Создайте файл .env в корне вашего проекта:

# Конфигурация базы данных
DB_HOST=localhost
DB_PORT=5432
DB_NAME=myapp
DB_USER=postgres
DB_PASSWORD=password123

# API ключи
API_KEY=your_api_key_here
SECRET_KEY=your_secret_key_here

Устранение неполадок

Распространенные проблемы

1. Код не форматируется: Проверьте правильность обратных кавычек
2. Подсветка синтаксиса не работает: Проверьте идентификатор языка
3. Код нарушает макет: Используйте правильные переносы строк

Экранирование обратных кавычек

Если вам нужно показать обратные кавычки в вашем коде:

Пример одинарной обратной кавычки:

• •
  Пишите: `код`
• •
  Результат: код

Пример тройных обратных кавычек:

• •
  Пишите: ```блок кода```
• •
  Результат: блок кода

Обратные кавычки во встроенном коде:

• •
  Пишите: ``обратная кавычка``
• •
  Результат: обратная кавычка

Блоки кода необходимы для технической документации. Используйте их, чтобы сделать ваши примеры кода ясными, читаемыми и правильно отформатированными!

Наконец, давайте изучим переносы строк для совершенства форматирования текста.