🦾 IT-Качалка Давида Шекунца 💪
2023-05-30 10:57
Ivan Zhuravlev
Расскажи подробнее зачем markdown заголовки нужны в комментах? Вообще, я использую обычный jsdoc с markdown в части description или examples. Но, заголовки никогда не писал, например, тот же jetbrains умеет jsdoc рендерить из текста в превью markdown и там будет наверное не очень читабельно, если заголовками писать. Но, интересно, поэксперементирую)
Я не стесняюсь писать процедурный код и некоторые мои функции могут достигать 1000 строчек кодаСамый живой пример: парсинг данных от устройств (IoT). Дело в том, что там одни свойства данных могут очень сильно влиять на другие и если бы мы делали на каждую обработку функции между которыми передавали эти куски данных (при этом иммутабельно), то рано или поздно окажется ситуация где одна глубокая ветка логики начинает зависеть от другой и приходится очень сильно рефакторить.Поэтому, я предпочитаю максимум логики оставлять в 1 главной функции, которая парсит, а вот когда я уверен, что ветка независимая или глубина ветки не более 1-2, тогда я выношу в отдельные функции.Вот в таком процедурном коде и возникает ситуация, где у тебя по 50-100 строчек кода представляют собой некоторую \"главу\" с \"подглавами\" и это хочется как-то обзначать.Для этого, перед главой я пишу комментари \"// Extracting sale data\", \"// Updating state\", \"// Deduplication\" и так далееНо, если просто писать комментарии, то в один момент встает вопрос: а вот этот комментарий связан с предыдущим или нет?И когда ты начинаешь к ним добавлять правила Markdown (в основном, заголовки, списки, можно еще bold, italic и т.д), тогда ты намного четче видишь какой кусок кода к какой главе относится и навигация по этой функции становится в разы легчеИ да, jsdoc я использую когда просто хочу описать саму функцию, но это скорее о том \"что здесь происходит\", а не \"как это происходит\"