Пишите комментарии: Пишите или пишете — как правильно? | Образование | Общество

Пишите или пишете — как правильно? | Образование | Общество

Есения Павлоцки

Примерное время чтения: 4 минуты

341776

Сюжет Говорим и пишем по-русски грамотно

Shutterstock.com

Отвечает Есения Павлоцки, лингвист-морфолог, эксперт института филологии, массовой информации и психологии Новосибирского государственного педагогического университета.

Верно и то, и другое, но всё зависит от смысла. Вернее, смысл высказывания будет зависеть от того, какую грамматическую форму вы выберете.

Самым простым решением оказываются вопросы, которые следует задать к глаголу: что делаете (пишете) или что делайте (пишите)? Первый адресуется к действию в настоящем, а второй к императиву, повелительному наклонению.

Если речь идет о глаголе в настоящем времени, то употребляем пишете. 

Почему? Глагол писать относится к первому спряжению (глагол на -ать). Согласно закономерности (а это результат сложных изменений в ходе развития нашего языка), в личных окончаниях глаголов первого спряжения мы пишем Е (-ем, -ешь, -ете, -ет).

Как только человек узнает об этом в школе, он сразу напрягается — иногда на всю жизнь: понять это почти невозможно и, как следствие, не так уж просто запомнить. И если выполнить домашнее задание помогут таблицы спряжений, то во взрослой жизни каждый раз обращаться к грамматическим алгоритмам проблематично.

Учить наизусть иррациональные (без погружения в историческую грамматику) закономерности действительно нелегко. В личных окончаниях I спряжения у нас Е, а II спряжения — И. Хорошо, но почему? Ответ на вопрос совсем не прост, и мы запоминаем это как аксиому.

А тем временем система, которая заставляет нас ломать голову — дышат или дышут, пишите или пишете, борятся

или борются — уже упрощена сама собой. Предшествовавшая ей система спряжений древнерусского языка была куда более сложной, а система времён содержала 4 прошедших, 2 будущих и настоящее время; во всех временах глаголы различались по лицам. 

Более того, спряжение форм настоящего времени в древнерусском языке было представлено тремя типами — I, II и нетематическим, которые различались лишь отдельными окончаниями.

Горшкова К. В., Хабургаев Г. А. Историческая грамматика русского языка, 1981.

В общем, ситуация на сегодня, очевидно, куда более простая. Но от этого не легче, и, конечно, проще запомнить то, что понятно. И если языковая интуиция — последняя надежда — не сложилась, то мучениям со склонениями, спряжениями и -ться/-тся не избежать.

Но, увы, это данность. Когда возникает вопрос «откуда это взялось», следует вспомнить: историческая грамматика похожа на известное английское стихотворение «Дом, который построил Джек», и уяснить пару алгоритмов намного проще, чем понять, что к ним привело.

Итак, в глаголе настоящего времени мы видим Е — пишете. Если же перед нами императив — пишите с И. От императива в целом отталкиваться проще: если нам нужно употребить напишете, то время уже не настоящее. Получается, что опять возникает путаница. С повелительным наклонением таких проблем не будет: пишите, напишите!

Еще один прием-подсказка — это ударение. Пишете — безударная позиция и Е, а пишите — ударная, И. Можно запомнить, с какой буквой сочетается ударение на определенном слоге, и избавиться от вопроса раз и навсегда.

Итак, императив пишите (я прошу вас/указываю вам писать) и глагол в форме настоящего времени пишете

(то, что вы сейчас/в целом делаете). 

Примеры употребления: Немедленно пишите, что вы отказываетесь; пишите мне чаще / Здесь вы пишете ваше имя; вы очень красиво пишете.

  • Ошибки есть даже в учебниках! Учитель русского языка о росте безграмотности →
  • Филолог о причинах безграмотности россиян →
  • До скольки и который час — как правильно? →

русский язык

Следующий материал

Также вам может быть интересно

  • Преумножить или приумножить — как правильно?
  • Риэлтор или риелтор — как правильно?
  • Андрей Шулимов: «Язык жестов людям понять легче, чем человеческую речь»

Новости СМИ2

Подписывайтесь на мой канал, ставьте лайки, пишите комментарии

Это чужой компьютер Забыли пароль?

    org/BreadcrumbList»>
  1. Главная
  2. Семья, Дом, Дети
  3. Прочие дела домашние
  4. Закрытый вопрос
  1. Прочие дела домашние
  2. Закрытый вопрос
  • Бизнес, Финансы
  • Города и Страны
  • Досуг, Развлечения
  • Животные, Растения
  • Здоровье, Красота, Медицина
  • Знакомства, Любовь, Отношения
  • Искусство и Культура
  • Компьютеры, Интернет, Связь
  • Кулинария, Рецепты
  • Лингвистика
  • Наука и Техника
  • Образование
  • Общество, Политика, СМИ
  • Отдельная Категория
  • Прочее
  • Путешествия, Туризм
  • Работа, Карьера
  • Семья, Дом, Дети
    • Беременность, Роды
    • Воспитание детей
    • Домашняя бухгалтерия
    • Домоводство
    • Загородная жизнь
    • Обстановка, Мебель
    • Организация быта
    • Прочие дела домашние
    • Свадьба, Венчание, Брак
    • Строительство и Ремонт
  • Спорт
  • Стиль, Мода, Звезды
  • Товары и Услуги
  • Транспорт
  • Философия, Психология
  • Фотография, Видеосъемка
  • Юридическая консультация

Юмор

Закрыт 7 лет

Личный кабинет удален

Наставник (46815)

#комментарий

Мы платим до 300 руб за каждую тысячу уникальных поисковых переходов на Ваш вопрос или ответ Подробнее

ЛУЧШИЙ ОТВЕТ ИЗ 3

~Лисёна~глаза зелёны~

Наставник (80446)

Обязательно, но при условии, что ты мне разрешишь заказывать передачи какие я хочу))

ЕЩЕ ОТВЕТЫ

Личный кабинет удален

Наставник (46815)

телеканал ЧЕ — ЧЕ ТЫ ЗЫРИШЬ?)

Личный кабинет удален

Наставник (46815)

лалилалай
лалилалайк

ПОХОЖИЕ ВОПРОСЫ

А если Вам писать в комментариях, «Привет, моя(моя)», понравится или бесить будет?

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

Этот трусливый царь-редиска удалил мой комментарий в стихах на его опус+

А зачем человек, сначала задавший вопрос, потом пишет комментарий к моему ответу, что

Тетёньки, не пишите комментарии к каждому моему ответу. .

мне кажецо — пора установить функцию комментариев к личным фото в лк, ну и возможность ставить лайки..)) — как вам ?

У тибя какой комментарий на мой вопрос ? )))

*ка!!!Выпустила меня из ЧС,что бы написать мне ответ—потом снова запихнула,что бы мой комментарий не дошел к ней..даун плять…и это не шизофрения?)))

Почему не приняли мой комментарий на «майл-ру»? (См. дополнение).

…как избежать звёздной болезни ,когда мой комментарий лайкнули?

Руководство инженера по написанию осмысленного кода Комментарии

«Что это делает?»

«Почему это не билет?»

Были там? Если вы чем-то похожи на большинство инженеров, можно с уверенностью сказать, что это случается с вами много раз .

Наиболее очевидное и непосредственное преимущество написания хороших комментариев заключается в том, что они облегчают понимание кода другими.

Но когда мы отрабатываем лучшие практики комментирования кода (в том числе когда и , когда , а не для написания комментариев), мы можем открыть еще более важные и долгосрочные преимущества, такие как:

  • повышение скорости проектирования
  • улучшение качества кода

С другой стороны, если мы не придерживаемся передовой практики, комментарии в коде могут иметь противоположный эффект. В конце концов, комментарии к коду — это неструктурированный способ хранения информации. Их нелегко найти или увидеть, кроме просмотра кода. Это делает их плохой альтернативой для надлежащей документации или отслеживания проблем. В сочетании с резким падением качества кода и проблемами со скоростью, которые они вызывают, плохое комментирование приводит к растущим проблемам, от огромных кривых обучения для новых инженеров до невидимых незавершенных работ по техническому долгу.

В этом полном руководстве по написанию осмысленных комментариев к коду мы:

  • Объясним, какие существуют типы комментариев
  • Обсудим, когда и как писать комментарии к коду
  • Расскажем о некоторых передовых методах комментирования кода
  • Обсудим, когда не их писать (а что делать вместо этого!)

Стоит ли вообще использовать комментарии?

Некоторые говорят, что если кусок кода написан хорошо, мы можем вообще отказаться от комментариев, потому что цель этого кода будет очевидна. Как говорит Джон Оустерхаут, это вкусный миф .

Комментарии действительно могут использоваться для замазывания плохого или неясного кода. Но суть в том, что разного рода информацию просто невозможно представить в коде.

Типы комментариев (и когда их использовать)

1. Контекстные комментарии

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

Первый тип — это комментарии на уровне модуля. Они описывают назначение классов, функций и методов.

Эти комментарии могут включать… 

  • Параметры, которые принимает функция
  • Результат, который она генерирует
  • Любые функции модуля, которые нельзя понять с первого взгляда.

Второй тип — логические комментарии. Они объясняют код в контексте, где бы они ни были нужны.  

Мы должны использовать их экономно. Последнее, что нужно вашей команде, — это комментарии, которые объясняют вещи, которые уже очевидны, если взглянуть на код!

Грамотно размещенные комментарии экономят время разработки и предотвращают неправильное понимание инженерами цели или контекста фрагмента кода. Когда мы неправильно понимаем код, это может привести к неэффективности, ненужной сложности и ошибкам. Это вредит качеству и скорости кода, особенно когда это происходит регулярно.

Когда их использовать: 

  • Если код неизбежно усложняется
  • Для добавления деталей для повышения точности, таких как единицы измерения, инклюзивность и эксклюзивность или обработка нулевых значений
  • Когда контекст отсутствует, например, при использовании кода из другого репо или пакета

Например, неясно, являются ли параметры «начало» и «конец» включающими или исключающими. Комментарий избавил бы читателей от разгадки.

Меньшее количество комментариев часто означает более читаемый код. Если кто-то увидит комментарий, он поймет, что он острый и ценный.

Когда их следует избегать: 

  • Когда назначение функции очевидно
  • В библиотеках или API
  • Когда это должно быть отмечено как проблема. (Вот как команды погребают под кучей технических долгов, даже не подозревая об этом.)

Вот важный момент: если инженеры пишут тонны комментариев, чтобы объяснить сложность, это может быть запахом кода.

Инженерная практика, которую должна принять ваша команда, заключается в последовательном документировании ненужного сложного кода как задач. Это позволяет избежать накопления серьезного технического долга, который может быть трудно погасить. Если вы еще не используете для этого инструмент, попробуйте Jira или Linear для отслеживания проблем на основе приложений. Или попробуйте Stepsize для отслеживания технического долга и управления им из редактора кода.

2. TODO/FIXME

TODO и FIXME повсюду. Но они сопряжены со значительными затратами.

TODO — отличный инструмент для одиночной игры… Они отлично подходят для временного сброса мыслей, чтобы вы могли сосредоточиться на том, что делаете. TODO определенно лучше, чем список сбоку, потому что у них есть контекст.

Но ужасный многопользовательский инструмент . Когда TODO попадают в `main`, вы получаете бесконечный, невидимый список невыполненных работ , который не подлежит действию.

Плохая практика комментариев — прямой путь к растущему техническому долгу и снижению качества кода.

Используйте TODO, чтобы помочь вашему личному процессу разработки кода. Никогда не отправляйте TODO в раздел «main».  

Если в вашей кодовой базе есть TODO, используйте инструмент управления задачами Stepsize, чтобы преобразовать их в задачи, не выходя из IDE. Инструмент также будет отображать TODO в PR, где вы можете превратить их в задачи.

Три передовых метода написания комментариев к коду

1. Сосредоточьтесь на

почему

Лучшие комментарии к коду — те, которые вам не нужны . Лучшие комментарии нельзя заменить кодом.

Взгляните на этот пример, который мы заимствовали у Джефа Раскина:

/* Бинарный поиск оказался медленнее, чем алгоритм Бойера-Мура для интересующих наборов данных, поэтому мы использовали более сложный, но более быстрый метод, хотя эта проблема на первый взгляд не кажется поддающейся решению с помощью метода строкового поиска. */

Код должен быть написан как можно проще. Лучшие комментарии объясняют неизбежную сложность. Например, мы можем добавить комментарий, объясняющий бизнес-приложение кода или обоснование выбора конкретного алгоритма.

Код говорит вам как . Комментарии говорят вам , почему .

2.

Не навязывайте TODO. Создавайте проблемы.

TODO должны быть только для одного игрока. TODO, которые передаются, приводят к бесконечному, невидимому отставанию , который не подлежит действию.

Если вы продвигаете TODO, вместо этого вы должны создавать задачу. Когда оставлять TODO в базе кода является привычкой всей команды, это приводит к растущему техническому долгу.

Используйте такой инструмент, как Stepsize, чтобы управлять проблемами, не выходя из базы кода. Stepsize интегрируется с такими платформами, как Jira и Linear, если вы этого хотите. Расширение VSCode находится здесь, а расширение Jetbrains — здесь. Этот инструмент позволит вам:

  • Преобразовать TODO в задачи одним щелчком
  • Отметьте задачи и проблемы в PR
  • Визуализируйте проблемы и технический долг в различных частях вашей кодовой базы
  • Сделайте управление проблемами простым для инженеров
  • Станьте героем технического долга!
Такие инструменты, как Stepsize, могут очищать TODO и управлять проблемами

3.

Выберите и задокументируйте соглашения.

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

Возможно, вы программируете на языке с помощью инструмента компиляции документов, такого как Javadoc для Java, godoc для Go! Или Doxygen для C++. Используйте их — хотя они и не идеальны, структурные преимущества перевешивают недостатки.

Выбирайте инструменты и методы решения проблем, интуитивно понятные для отдельных инженеров и приносящие пользу команде. Вы запрещаете TODO в `main` или у вас есть политика документирования проблем? Убедитесь, что это все понимают.

Как только передовой опыт становится привычкой в ​​команде, он становится легким вкладом в более быструю и качественную разработку кода и надлежащее управление техническим долгом.

Закрепление ваших принципов окупается, когда инженеры присоединяются к вашей команде или покидают ее.

Округление

Комментирование кода — это не только умение писать хорошие комментарии. Это также о том, чтобы знать, когда , а не , и что делать вместо этого.

Когда мы делаем это правильно, мы не просто облегчаем понимание другим. Мы:

  • Ускорение разработки
  • Улучшение качества кода
  • Повышение морального духа команды
  • Управление и устранение технического долга
  • 20002 Во-первых, когда мы пишем хорошие комментарии, мы постоянно выявляем важную информацию об особенностях кода и архитектурных решениях.

    Во-вторых, когда мы избегаем комментариев о проблемах кода и вместо этого создаем проблемы, мы обеспечиваем возможность действий и видимость проблем . Это продвигает передовые методы управления техническим долгом, которые позволяют вашей команде решать проблемы с техническим долгом.

    Оптимизируйте процесс документирования и устранения проблем с техническими долгами в вашей команде с помощью инструмента управления проблемами Stepsize. Это позволяет:

    • Создание, просмотр и управление задачами в редакторе кода
    • Преобразование TODO в задачи
    • Использование мощных инструментов для визуализации технического долга 
    • Понимание того, как технический долг влияет на вашу кодовую базу (и вашу команду)

    Получите расширение VSCode здесь или расширение Jetbrains здесь .

    Написание комментариев на Python (Руководство) — Real Python

    by Jaya Zhanébasicsbest-practices