Экранирование символов
Escape-символы позволяют отображать символы в Markdown, которые в противном случае имели бы специальные значения. Добавляя обратную косую черту \
перед символом, вы можете отменить его специальную функцию.
Базовая концепция экранирования
Что такое экранирование
В Markdown некоторые символы имеют специальные значения (например, *
для акцентирования). Когда вы хотите отобразить сами эти символы, вам нужно использовать экранирование.
Это *курсивный* текст.
Это \*обычная звездочка\* текст.
Результат:
Это курсивный текст. Это *обычная звездочка* текст.
Символы, требующие экранирования
Полный список
Следующие символы имеют специальные значения в Markdown и требуют экранирования:
Символ | Описание | Синтаксис экранирования | Использование |
---|---|---|---|
\ | Обратная косая черта | \\ | Символ экранирования |
` | Обратная кавычка | \` | Встроенный код |
* | Звездочка | \* | Акцентирование, списки |
_ | Подчеркивание | \_ | Акцентирование |
{} | Фигурные скобки | \{ \} | Расширенный синтаксис |
[] | Квадратные скобки | \[ \] | Ссылки, изображения |
() | Круглые скобки | \( \) | Ссылки, изображения |
# | Решетка | \# | Заголовки |
+ | Плюс | \+ | Списки |
- | Тире | \- | Списки, горизонтальная линия |
. | Точка | \. | Нумерованные списки |
! | Восклицательный знак | \! | Изображения |
Распространенные примеры экранирования
Звездочки и подчеркивания
❌ Не экранировано:
Это имя файла file_name_v2.txt
Это формула 2*3*4 = 24
✅ Экранировано:
Это имя файла file\_name\_v2.txt
Это формула 2\*3\*4 = 24
Результат:
❌ Не экранировано: Это имя файла file_name_v2.txt Это формула 234 = 24
✅ Экранировано: Это имя файла file_name_v2.txt Это формула 2*3*4 = 24
Заголовки с решеткой
❌ Не экранировано:
# TODO: Завершить задачу
✅ Экранировано:
\# TODO: Завершить задачу
Результат:
❌ Не экранировано:
TODO: Завершить задачу
✅ Экранировано: # TODO: Завершить задачу
Символы списков
❌ Не экранировано:
Цена: 100 - 200 USD
Шаги: 1. Подготовка 2. Выполнение
✅ Экранировано:
Цена: 100 \- 200 USD
Шаги: 1\. Подготовка 2\. Выполнение
Результат:
❌ Не экранировано: Цена: 100 - 200 USD Шаги: 1. Подготовка 2. Выполнение
✅ Экранировано: Цена: 100 - 200 USD Шаги: 1. Подготовка 2. Выполнение
Синтаксис ссылок
❌ Не экранировано:
Смотрите документацию [здесь](http://example.com)
✅ Экранировано (показ исходного синтаксиса):
Смотрите документацию \[здесь\]\(http://example.com\)
Результат:
❌ Не экранировано: Смотрите документацию здесь
✅ Экранировано (показ исходного синтаксиса): Смотрите документацию [здесь](http://example.com)
Специальные случаи
Сама обратная косая черта
Чтобы отобразить символ обратной косой черты, используйте двойную обратную косую черту:
Путь к файлу: C:\\Users\\Username\\Documents
Путь в Unix: /home/user/documents
Результат:
Путь к файлу: C:\Users\Username\Documents Путь в Unix: /home/user/documents
Экранирование обратных кавычек
Чтобы отобразить обратные кавычки в коде:
Используйте `` \` `` для обрамления кода
Используйте ``` \`\`\` ``` для создания блоков кода
Результат:
Используйте \`
для обрамления кода Используйте \`\`\`
для создания блоков кода
Обратная косая черта в конце строки
Обратная косая черта в конце строки имеет специальное значение (принудительный перевод строки):
Первая строка\
Вторая строка (принудительный перевод строки)
Первая строка\\
Вторая строка (показывает обратную косую черту)
Результат:
Первая строка
Вторая строка (принудительный перевод строки)
Первая строка\ Вторая строка (показывает обратную косую черту)
Экранирование в коде
Встроенный код
Во встроенном коде большинство символов не требуют экранирования:
Код: `let result = 2 * 3 + 1;`
Путь: `C:\Users\*\Documents`
Результат:
Код: let result = 2 * 3 + 1;
Путь: C:\Users\*\Documents
Блоки кода
В блоках кода символы сохраняются как есть:
```javascript
// Эти символы не требуют экранирования
const pattern = /[.*+?^${}()|[\]\\]/g;
const path = "C:\\Users\\*\\Documents";
```
Результат:
// Эти символы не требуют экранирования
const pattern = /[.*+?^${}()|[\]\\]/g;
const path = "C:\\Users\\*\\Documents";
Практические сценарии применения
1. Техническая документация
## Синтаксис файла конфигурации
Файл конфигурации использует следующий формат:
# Строка комментария key = value [section]
Примечание:
- Используйте \# для начала комментария
- Используйте \[\] для определения секции
- Используйте \* как подстановочный знак
2. Математические выражения
## Математические формулы
Линейное уравнение: y = a\*x + b
Квадратное уравнение: y = a\*x² + b\*x + c
Дробь: 1/2 = 0.5
Примечание: Используйте \* как оператор умножения