0 added
0 removed
Original
2026-01-01
Modified
2026-02-26
1
<p><strong>На нескольких простых примерах разбираем, как писать понятные комментарии в коде и для чего их группировать.</strong></p>
1
<p><strong>На нескольких простых примерах разбираем, как писать понятные комментарии в коде и для чего их группировать.</strong></p>
2
<h2>#TODO</h2>
2
<h2>#TODO</h2>
3
<p>Разработчики используют этот комментарий, чтобы указать на необходимость будущего рефакторинга. Комментарий #TODO позволяет обозначить, что именно нужно будет добавить в этой части кода и для чего это необходимо.</p>
3
<p>Разработчики используют этот комментарий, чтобы указать на необходимость будущего рефакторинга. Комментарий #TODO позволяет обозначить, что именно нужно будет добавить в этой части кода и для чего это необходимо.</p>
4
<blockquote><h3>Читайте также:</h3>
4
<blockquote><h3>Читайте также:</h3>
5
<p>Как читать чужой код: 6 правил, которые стоит<a>помнить разработчику</a></p>
5
<p>Как читать чужой код: 6 правил, которые стоит<a>помнить разработчику</a></p>
6
</blockquote><h2>#FIXME</h2>
6
</blockquote><h2>#FIXME</h2>
7
<p>Тег #FIXME показывает, что в этой части кода нужно что-то исправить. В некоторых случаях функциональность этого тега сливается с #TODO, поэтому #FIXME рекомендуется использовать, когда нужно указать на участок кода, от которого в будущем могут потенциально возникать проблемы.</p>
7
<p>Тег #FIXME показывает, что в этой части кода нужно что-то исправить. В некоторых случаях функциональность этого тега сливается с #TODO, поэтому #FIXME рекомендуется использовать, когда нужно указать на участок кода, от которого в будущем могут потенциально возникать проблемы.</p>
8
<h2>#Warning</h2>
8
<h2>#Warning</h2>
9
<p>По названию тега можно понять, что если перед кодом стоит такой комментарий с объяснением проблемы, то запускать такой код нужно очень аккуратно.</p>
9
<p>По названию тега можно понять, что если перед кодом стоит такой комментарий с объяснением проблемы, то запускать такой код нужно очень аккуратно.</p>
10
<h2>#Error</h2>
10
<h2>#Error</h2>
11
<p>Этот тег указывает на ошибку в коде - в комментарии разработчик может объяснить проблему и причину, почему ее не удалось решить. Обычно комментарий с таким тегом оставляют около участка кода, который совсем не запускается, либо не проходит тесты.</p>
11
<p>Этот тег указывает на ошибку в коде - в комментарии разработчик может объяснить проблему и причину, почему ее не удалось решить. Обычно комментарий с таким тегом оставляют около участка кода, который совсем не запускается, либо не проходит тесты.</p>
12
<h2>Как правильно применять теги</h2>
12
<h2>Как правильно применять теги</h2>
13
<p>В каждой основной IDE есть плагины для работы с комментариями и их группировки. Например, в VS Code самый распространенный способ работы с такими комментариями - плагин<a>Todo Tree</a>, создающий дерево из групп комментариев для эффективной работы с ними.</p>
13
<p>В каждой основной IDE есть плагины для работы с комментариями и их группировки. Например, в VS Code самый распространенный способ работы с такими комментариями - плагин<a>Todo Tree</a>, создающий дерево из групп комментариев для эффективной работы с ними.</p>
14
<p>В IDE от JetBrains комментарии #TODO и #FIXME автоматически определяются средой разработки в единые группы тегов. Подробнее об этом и том, как можно расширить функционал этой фичи на другие пользовательские комментарии, можно почитать на сайте<a>JetBrains</a>.</p>
14
<p>В IDE от JetBrains комментарии #TODO и #FIXME автоматически определяются средой разработки в единые группы тегов. Подробнее об этом и том, как можно расширить функционал этой фичи на другие пользовательские комментарии, можно почитать на сайте<a>JetBrains</a>.</p>
15
<blockquote><h3>Напишите свое лучшее резюме</h3>
15
<blockquote><h3>Напишите свое лучшее резюме</h3>
16
<p>У нас есть сервис<a>Хекслет CV</a>, где любой разработчик может опубликовать свое резюме и получить бесплатные комментарии от других программистов и HR-менеджеров, как его улучшить и что добавить к рекомендательному письму.</p>
16
<p>У нас есть сервис<a>Хекслет CV</a>, где любой разработчик может опубликовать свое резюме и получить бесплатные комментарии от других программистов и HR-менеджеров, как его улучшить и что добавить к рекомендательному письму.</p>
17
</blockquote>
17
</blockquote>