0 added
0 removed
Original
2026-01-01
Modified
2026-02-26
1
<p>В этом уроке мы поговорим о финальном шаге работы над текстом - правильном оформлении фрагментов кода. Здесь вы узнаете, какие стандарты оформления приняты на Хекслете.</p>
1
<p>В этом уроке мы поговорим о финальном шаге работы над текстом - правильном оформлении фрагментов кода. Здесь вы узнаете, какие стандарты оформления приняты на Хекслете.</p>
2
<p>Сначала обсудим<strong>общие правила оформления</strong>:</p>
2
<p>Сначала обсудим<strong>общие правила оформления</strong>:</p>
3
<ul><li>Оформление кода должно соответствовать стандартам кодирования, принятым в языке программирования</li>
3
<ul><li>Оформление кода должно соответствовать стандартам кодирования, принятым в языке программирования</li>
4
<li>Если вы работаете в формате Markdown, обязательно настройте линтер и превью готового документа в своем редакторе кода. Для единого стиля мы рекомендуем линтер<a>markdownlint</a></li>
4
<li>Если вы работаете в формате Markdown, обязательно настройте линтер и превью готового документа в своем редакторе кода. Для единого стиля мы рекомендуем линтер<a>markdownlint</a></li>
5
<li>Обратные одинарные кавычки (бэктики) используем только для кода: const a = 5;</li>
5
<li>Обратные одинарные кавычки (бэктики) используем только для кода: const a = 5;</li>
6
<li>В тексте урока определения и важные понятия выделяем болдом: "Чтобы не копировать выражение, достаточно создать с ним<strong>переменную</strong>"</li>
6
<li>В тексте урока определения и важные понятия выделяем болдом: "Чтобы не копировать выражение, достаточно создать с ним<strong>переменную</strong>"</li>
7
<li>Для обозначения комбинации клавиш можно использовать парный тег: <kbd>Ctrl+P</kbd> для Markdown</li>
7
<li>Для обозначения комбинации клавиш можно использовать парный тег: <kbd>Ctrl+P</kbd> для Markdown</li>
8
</ul><h2>Фрагменты кода</h2>
8
</ul><h2>Фрагменты кода</h2>
9
<p>Примеры кода отбиваются пустыми строками:</p>
9
<p>Примеры кода отбиваются пустыми строками:</p>
10
<h2>Функции</h2>
10
<h2>Функции</h2>
11
<p>Для описания функций следует опираться на следующие правила:</p>
11
<p>Для описания функций следует опираться на следующие правила:</p>
12
<p><strong>Правило 1</strong>. Если функция экспортируется по умолчанию, то имя функции опускается:</p>
12
<p><strong>Правило 1</strong>. Если функция экспортируется по умолчанию, то имя функции опускается:</p>
13
<p><strong>Правило 2</strong>. Имя функции обрамляется бэктиками и указывается со скобками вызова, даже если аргументы отсутствуют:</p>
13
<p><strong>Правило 2</strong>. Имя функции обрамляется бэктиками и указывается со скобками вызова, даже если аргументы отсутствуют:</p>
14
<p><strong>Правило 3</strong>. Во фрагментах кода вызов функции, экспортированной по умолчанию, указывается с импортом:</p>
14
<p><strong>Правило 3</strong>. Во фрагментах кода вызов функции, экспортированной по умолчанию, указывается с импортом:</p>
15
<h2>Имена файлов</h2>
15
<h2>Имена файлов</h2>
16
<p>В тексте упражнения имена файлов форматируются курсивом:</p>
16
<p>В тексте упражнения имена файлов форматируются курсивом:</p>
17
<p>Таким же образом оформляются пути файловой системы и названия библиотек:</p>
17
<p>Таким же образом оформляются пути файловой системы и названия библиотек:</p>
18
<h2>Импорты</h2>
18
<h2>Импорты</h2>
19
<p>При первом использовании кода, определенного в других неймспейсах, модулях, пакетах, нужно показывать его импорт.</p>
19
<p>При первом использовании кода, определенного в других неймспейсах, модулях, пакетах, нужно показывать его импорт.</p>
20
<p>Далее выводим импорт по необходимости.</p>
20
<p>Далее выводим импорт по необходимости.</p>
21
<h2>Команды</h2>
21
<h2>Команды</h2>
22
<p>Для демонстрации команд и их вывода используют тройные бектики с языком ```bash. В примерах команд нет дополнительных символов $ или #. Пример оформления:</p>
22
<p>Для демонстрации команд и их вывода используют тройные бектики с языком ```bash. В примерах команд нет дополнительных символов $ или #. Пример оформления:</p>
23
<h2>Результат</h2>
23
<h2>Результат</h2>
24
<p>Для демонстрации результата выражения используются две конструкции:</p>
24
<p>Для демонстрации результата выражения используются две конструкции:</p>
25
<ul><li>Просто комментарий</li>
25
<ul><li>Просто комментарий</li>
26
<li>Комментарий со стрелкой =></li>
26
<li>Комментарий со стрелкой =></li>
27
</ul><p>Вывод демонстрируется как есть (без дополнительных кавычек). Стрелка добавляется там, где результат выводится на экран:</p>
27
</ul><p>Вывод демонстрируется как есть (без дополнительных кавычек). Стрелка добавляется там, где результат выводится на экран:</p>
28
<p>Если комментарий не помещается в одну строку, то лучше перенести его ниже:</p>
28
<p>Если комментарий не помещается в одну строку, то лучше перенести его ниже:</p>
29
29