Комментарии хорошие: «зачем», а не «как» / Хабр

Содержание

«зачем», а не «как» / Хабр

Привет, Хабр! Представляю вашему вниманию перевод статьи

«Writing good comments: the why, not the how»

автора Jack Franklin.

Комментирование кода в программистской среде нередко считается пустой тратой времени или неким сигналом о том, что код можно и улучшить. Вот цитата из файла CONTRIBUTING.md, который я нашёл на Гитхабе (и таких примеров очень, очень много):

Комментариев следует избегать. Если ваш код нельзя понять без комментариев, перепишите его так, чтобы он сам себя объяснял.

Я считаю, что в большинстве случаев такой совет будет неудачным и неверным.

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


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

Итак, положим, вы свежеиспечённый студент, только начавший этот курс. Что вы будете делать? Комментировать код, конечно же!

// задаём значение из переменной окружения bar
const inputValue = process.ENV.bar

// а теперь умножим на 2
const newValue = inputValue * 2

// теперь передадим значение функции square
const finalValue = square(newValue)

// эта функция возводит число в квадрат и возвращает результат
const square = (x) => x * x

Люди, говорящие, что комментарии — это плохо, на самом деле думают о таких вот комментариях. И они при этом совершенно правы! Комментарии вроде тех, что выше, отвечающие в программировании на вопрос «как?», совершенно бесполезны. Все эти комментарии не привнесли в код ничего, что нельзя понять из него самого.

Отвечайте на вопрос «зачем?»

Проблема с комментариями выше заключается в том, что они объясняют,

как

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

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

Как-то раз работал я в процессинговой компании. У нас каждый день выполнялся огромный SQL-запрос, выбиравший платежи для выплаты. Запрос был хорошо оптимизированным — нам нужно было, чтобы он работал весьма быстро — и притом крайне сложным: приходилось учитывать множество пограничных случаев. Мы очень старались, чтобы он был настолько ясным, насколько вообще возможно. Впрочем, этот запрос никогда не смог бы полноценно быть интуитивно понятным и лёгким для восприятия. Он просто содержал слишком много кода с кучей условий и логикой, понять которую можно было лишь в контексте нашей компании и того, как она работала.

Я хотел найти пример, который можно будет здесь показать, поэтому я отправился в дебри кодовой базы React, чтобы что-нибудь найти. Не нужно быть React-разработчиком, чтобы понять суть. Итак, вот код, который я хотел бы особенно выделить:

// Сейчас key может быть передана как свойство. Это потенциальный источник проблем, 
// если key при этом отдельно явно объявлена (например, <div {...props} key="Hi" />
// или <div key="Hi" {...props} /> ). Тут следовало бы исключать key, переданную со свойствами,
// но пока что мы используем jsxDEV во всех случаях, кроме
// <div {...props} key="Hi" />, потому что на данный момент невозможно понять,
// объявлена ли явно key неопределённой или нет. 
if (maybeKey !== undefined) {
  key = '' + maybeKey
}

(

И вот ссылка на него на Гитхабе

).

Обратите внимание на сам код, о котором речь:

if (maybeKey !== undefined) {
  key = '' + maybeKey
}

Не так сложно понять, что он делает. Если значение maybeKey не неопределено, мы присваиваем переменной key переведённое в строку значение maybeKey.

Пометка: это небольшой JavaScript-трюк — '' + maybeKey
переведёт содержимое maybeKey в строку.

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

Если хотите посмотреть на какой-нибудь комментарий, который я оставлял в написанном мной коде, то вот один из них (TypeScript/Closure Compiler). Это хороший пример того типа комментариев, которые я считаю очень ценными.

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

зачем он это делает. Так что оставьте своим коллегам (или будущему-себе-через-шесть-месяцев) немного контекста о том, почему и для чего ваш код делает то, что он делает. Будет гораздо лучше.

Как писать хорошие комментарии к коду: «зачем», а не «как»

Привет, Хабр! Представляю вашему вниманию перевод статьи «Writing good comments: the why, not the how» автора Jack Franklin.

Комментирование кода в программистской среде нередко считается пустой тратой времени или неким сигналом о том, что код можно и улучшить. Вот цитата из файла CONTRIBUTING.md, который я нашёл на Гитхабе (и таких примеров очень, очень много):

Комментариев следует избегать. Если ваш код нельзя понять без комментариев, перепишите его так, чтобы он сам себя объяснял.

Я считаю, что в большинстве случаев такой совет будет неудачным и неверным. Полагаю, этот подход тянется корнями к учебному опыту большинства людей, изучавших программирование. Когда я изучал в университете компьютерные науки (хотя этот совет можно найти во многих курсах, не обязательно университетских), мне очень запомнился в первом же семестре один преподаватель, который говорил:
У каждой строки кода должен быть комментарий, объясняющий, что она делает. Ваша работа в курсе будет оцениваться по этому критерию.

Итак, положим, вы свежеиспечённый студент, только начавший этот курс. Что вы будете делать? Комментировать код, конечно же!
// задаём значение из переменной окружения bar const inputValue = process.ENV.bar // а теперь умножим на 2 const newValue = inputValue * 2 // теперь передадим значение функции square const finalValue = square(newValue) // эта функция возводит число в квадрат и возвращает результат const square = (x) => x * x

Люди, говорящие, что комментарии — это плохо, на самом деле думают о таких вот комментариях. И они при этом совершенно правы! Комментарии вроде тех, что выше, отвечающие в программировании на вопрос «как?», совершенно бесполезны. Все эти комментарии не привнесли в код ничего, что нельзя понять из него самого.

Отвечайте на вопрос «зачем?»


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

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

Как-то раз работал я в процессинговой компании. У нас каждый день выполнялся огромный SQL-запрос, выбиравший платежи для выплаты. Запрос был хорошо оптимизированным — нам нужно было, чтобы он работал весьма быстро — и притом крайне сложным: приходилось учитывать множество пограничных случаев. Мы очень старались, чтобы он был настолько ясным, насколько вообще возможно. Впрочем, этот запрос никогда не смог бы полноценно быть интуитивно понятным и лёгким для восприятия. Он просто содержал слишком много кода с кучей условий и логикой, понять которую можно было лишь в контексте нашей компании и того, как она работала.

Я хотел найти пример, который можно будет здесь показать, поэтому я отправился в дебри кодовой базы React, чтобы что-нибудь найти. Не нужно быть React-разработчиком, чтобы понять суть. Итак, вот код, который я хотел бы особенно выделить:

// Сейчас key может быть передана как свойство. Это потенциальный источник проблем, 
// если key при этом отдельно явно объявлена (например, <div {...props} key="Hi" />
// или <div key="Hi" {...props} /> ). Тут следовало бы исключать key, переданную со свойствами,
// но пока что мы используем jsxDEV во всех случаях, кроме
// <div {...props} key="Hi" />, потому что на данный момент невозможно понять,
// объявлена ли явно key неопределённой или нет. 
if (maybeKey !== undefined) {
  key = '' + maybeKey
}

(И вот ссылка на него на Гитхабе).

Обратите внимание на сам код, о котором речь:

if (maybeKey !== undefined) {
  key = '' + maybeKey
}

Не так сложно понять, что он делает. Если значение maybeKey не неопределено, мы присваиваем переменной key переведённое в строку значение maybeKey. Пометка: это небольшой JavaScript-трюк — '' + maybeKey переведёт содержимое maybeKey в строку.

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

Если хотите посмотреть на какой-нибудь комментарий, который я оставлял в написанном мной коде, то вот один из них (TypeScript/Closure Compiler). Это хороший пример того типа комментариев, которые я считаю очень ценными.

Любой код в итоге можно понять. В конце концов, код — не что иное, как инструкции, объясняющие компьютеру порядок действий. Код может сбивать с толку, но он не может лгать; если времени достаточно, любой разработчик может пошагово разобрать код и понять, что тот делает. Куда уж сложнее иногда понять, зачем он это делает. Так что оставьте своим коллегам (или будущему-себе-через-шесть-месяцев) немного контекста о том, почему и для чего ваш код делает то, что он делает. Будет гораздо лучше.

восстановление китайской экономики — хорошие новости для глобальной экономики_Russian.news.cn

Пекин, 17 июня /Синьхуа/ — Китай стал первой в мире крупной экономикой, которой удалось выйти из рецессии и встать на путь роста с начала вспышки пандемии COVID-19. Отскок экономики Китая опроверг предсказания лиц, скептически настроенных по отношению к китайской экономике, а также предоставил надежду другим странам, стремящимся к восстановлению от того кризиса, который привел к глобальному спаду.

Во втором квартале 2020 год валовой внутренний продукт /ВВП/ Китая увеличился на 3,2 проц. в годовом выражении. В сравнении с падением ВВП на 6,8 проц. в первом квартале, этот отскок показал, что вторая в мире по величине экономика имеет прочную основу для дальнейшего подъема.

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

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

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

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

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

Китайское правительство приложит дальнейшие усилия для увеличения внутреннего спроса, поскольку восстановление потребления в Китае по-прежнему сталкивается с препятствиями: розничные продажи потребительских товаров в первом полугодии с. г. сократились на 11,4 проц. в годовом исчислении. В стране будут полностью реализованы политики и меры по обеспечению занятости, улучшению благосостоянию народа и содействию развитию субъектов рынка, что предоставит новые возможности китайским и иностранным предприятиям.

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

Для сегодняшнего мира, столкнувшегося с такими вызовами, как эпидемия COVID-19, подъем протекционизма и другие неопределенности, 2020 является годом потрясений. В эти трудные времена, как бы ни развивалась внутренняя и международная экономическая ситуация, Китай всегда будет стоять на правильной стороне истории.

Комментарий: 2017-й — год (не)хороших новостей для ЕС? | Комментарии обозревателей DW и приглашенных авторов | DW

Наступивший 2017 год может быть для Евросоюза лучше, чем 2016-й. Должен быть лучше! Европа в политическом смысле вряд ли сможет вынести еще один год кризисов и катастроф, террора и ударов судьбы. С политической точки зрения, плохо и тяжело было уже в 2015 году. А 2016-й был еще хуже. В 2017 году должны, наконец, начаться перемены к лучшему. Будем надеяться! Ведь все, что нас до сих пор не смогло сломить, сделает нас сильнее, сказал один из еврокомиссаров накануне Рождества. Пусть он окажется прав. Так должно быть. Прошу, пожалуйста!

Хорошие новости из Европы

2017-й должен принести Европе позитивные события: в ЕС будет проложен единый кабель для мобильной телефонной связи. Нас ожидает чемпионат Европы по футболу среди женщин! Он будет проходить в Нидерландах. В октябре в Берлине откроют новый аэропорт. Скорее всего, откроют. Ну, или может быть… М-да!

Бернд Ригерт

Уже в начале года пройдут первые концерты в Эльбской филармонии в Гамбурге. Наконец-то у Европы появится новый символ, новый храм культуры! Несмотря на долговой кризис в Греции и банковский в Италии, экономика еврозоны в 2017 году будет расти, инфляция остается на низком уровне. Понятно, что Европейский центральный банк (ЕЦБ) обеспечивает медленный рост с помощью массы «дешевых денег». Однако же обеспечивает!

В 2017 году Франкфурт-на-Майне окажется в центре внимания, причем не из-за ЕЦБ, а статуса «зеленой столицы Европы». Здесь можно будет получить всю информацию о возобновляемых источниках энергии, экологичном строительстве и новых транспортных технологиях, которые способствуют защите климата. И, безусловно, это тоже важно!

Вопросы, на которые нет ответа

Но на этом, к сожалению, позитивные новости для европейцев в наступившем году заканчиваются. Последствия кризисов, разразившихся в 2016 году, будут ощутимы и в 2017-м: исламистский терроризм, Brexit, популизм, растущее разочарование в ЕС. «Поликризис» — так назвал эту ситуацию глава Еврокомиссии Жан-Клод Юнкер. Не самое радостное настроение усугубляется еще и неуверенностью, связанной со вступлением в должность президента США непредсказуемого Дональда Трампа.

Кроме того, всех беспокоит целый ряд других важных вопросов: одержит ли победу на президентских выборах во Франции правая популистка Марин Ле Пен — ярая противница Евросоюза? Какой будет Германия, важнейшая страна ЕС, осенью, после выборов — с изрядно подрастерявшей силы Меркель или вообще без нее? Как изменится европейское общество из-за постоянно возрастающей террористической угрозы?

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

Юбилейный год и повод праздновать

Однако 2017 год для европейцев — это еще и повод для радости и торжества. Ведь Евросоюзу исполняется 60 лет! Но празднование этого события в Риме в марте не будет столь бурным, хотя именно европейское единство подарило нам мир и благосостояние. До настоящего момента. Хотя об этом почему-то никто больше не желает слышать. Евросоюз может и должен пусть медленно, но начать выходить из кризиса. Ведь за ним со всех сторон пристально наблюдают деспоты и враги демократии: Эрдоган, Путин, Орбан, Трамп.

При этом 2017-й вряд ли станет годом разительных перемен. Скорее, это будет год ожиданий и попыток выкарабкаться. Если бы можно было просто перепрыгнуть этот год и оказаться сразу в 2018-м?! Или изменить реальность при помощи фейковых новостей, на этот раз позитивных, например, таких: «Евросоюз преодолел миграционный кризис». Или: «В ЕС число безработных уменьшилось вдвое». А еще лучше так: «Популисты сдались — Фараж и Джонсон уличены в употреблении допинга. Решение о Brexit не имеет законной силы». Но, к сожалению, это слишком хорошо, чтобы быть правдой!

Итак, нам не остается ничего другого, нежели, сжав кулаки и стиснув зубы, преодолевать все препятствия и жить дальше. 2017-й тоже закончится. А вот 2018 совершенно точно будет позитивнее и лучше! Тогда у нас будет повод порадоваться ЧМ по футболу в чудесной стране допинга — России с ее вновь избранным по итогам сфальсифицированных выборов президентом Путиным. А также вспоминать о конце чудовищной катастрофы прошлого века — Первой мировой войне. В общем как-то так.

Автор: Бернд Ригерт, обозреватель DW

Смотрите также:

  • 2017: лучшие цели для арт-путешествия по Европе

    Январь

    Самый известный европейский долгострой, Эльбская филармония в Гамбурге, наконец-то, завершен. Ее официальное открытие намечено на 11 января. Но заглянуть в фойе здания уже можно было за несколько дней до него, когда театр знаменитой берлинской танцовщицы и хореографа Саши Вальц представлял свой новый перформанс.

  • 2017: лучшие цели для арт-путешествия по Европе

    Февраль

    С 9 по 19 февраля в немецкой столице в 67-й раз проводится ежегодный международный кинофестиваль Берлинале, на котором значимая роль отводится политическому кино. Это один из самых престижных форумов такого рода в мире. Его главный приз — «Золотой медведь», присуждаемый за лучший фильм. На сей раз жюри возглавляет нидерландский режиссер и сценарист Пол Верхофен.

  • 2017: лучшие цели для арт-путешествия по Европе

    Март

    В Кельне 7 марта начинается литературный фестиваль Lit.Cologne — один из самых популярных подобных форумов в Европе. 195 чтений с участием авторов со всего мира намечено в рамках его программы. Lit.Cologne откроет акция солидарности с писателями и журналистами, преследуемыми турецкими властями. А 23 марта состоится другое крупное событие — открытие Лейпцигской международной книжной ярмарки.

  • 2017: лучшие цели для арт-путешествия по Европе

    Апрель

    documenta, одна из крупнейших выставок современного искусства в мире, проходящая каждые пять лет в немецком Касселе, в 2017 году впервые за свою 60-летнюю историю состоится сразу в двух городах — в Касселе и Афинах. Торжества по случаю ее открытия намечены 8 апреля в греческой столице. А в Историческом музее Берлина в это время стартует выставка «Эффект Лютера», посвященная 500-летию Реформации.

  • 2017: лучшие цели для арт-путешествия по Европе

    Май

    Роль художника в мире конфликтов — такова тема 57-й Венецианской биеннале современного искусства, площадкой которой жемчужина Адриатики будет с 13 мая по 26 ноября. Эта выставка проходит каждые два года. Немецкий павильон на сей раз возглавляет художник и перформер Анне Имхоф (сцена из него — на фото). А тем временем 17 мая во Франции стартует 70-й Каннский кинофестиваль.

  • 2017: лучшие цели для арт-путешествия по Европе

    Июнь

    Лишь раз в десятилетие выставка скульптуры и арт-объектов Skulptur Projekte в Мюнстере совпадает с выставкой современного искусства documenta в Касселе. Оба фестиваля начинаются 10 июня. Участники Skulptur Projekte создают свои творения прямо на этом форуме, а потом они три месяца экспонируются под открытым небом. А 15-18 июня — время работы арт-ярмарки Art Basel в швейцарском Базеле.

  • 2017: лучшие цели для арт-путешествия по Европе

    Июль

    Уникальный оперный Байройтский фестиваль, где исполняются музыкальные драмы Рихарда Вагнера, начинается 25 июля в Баварии. Его открывает опера «Парсифаль». Ее новый дирижер — Хартмут Хенхен (Hartmut Haenchen), заменивший ушедшего в отставку Андриса Нельсона. В рамках фестиваля намечено проведение симпозиума на тему «Вагнер при национал-социализме».

  • 2017: лучшие цели для арт-путешествия по Европе

    Август

    Крупная выставка, отражающая творчество китайских фотохудожников за последние пять десятилетий, открывается 18 августа в Музее фотографии в Берлине. А 22 августа в Кельне стартует международная ярмарка компьютерных игр Gamescom — настоящий рай для геймеров. Свои последние разработки здесь представляют компании со всего мира.

  • 2017: лучшие цели для арт-путешествия по Европе

    Сентябрь

    «К далекой возлюбленной» называется первый вокальный цикл Людвига ван Бетховена. Глава открывающегося 8 августа в Бонне Бетховенского фестиваля Ника Вагнер хочет, чтобы в этом году форум приобрел более лирическую тональность и чтобы на нем звучали не только симфонии и сонаты, но и камерно-вокальная музыка Бетховена, в области которой он был истинным первопроходцем.

  • 2017: лучшие цели для арт-путешествия по Европе

    Октябрь

    Презентации, литературные чтения, встречи с писателями и поэтами, концерты, — программа Франкфуртской книжной ярмарки, как всегда, обширна и разнообразна. 11 октября этот крупнейший в мире такого рода форум в 69-й раз откроет свои двери. Его кульминацией станет вручение Премии мира немецких книготорговцев и Немецкой литературной премии. В этом году страной — почетной гостьей ярмарки будет Франция.

  • 2017: лучшие цели для арт-путешествия по Европе

    Ноябрь

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

  • 2017: лучшие цели для арт-путешествия по Европе

    Декабрь

    Знаменитая ярмарка современного искусства Art Basel, обычно проходящая в швейцарском Базеле, в конце года на время переносится в США. С 7 по 10 декабря ее площадкой станет Майями-Бич, штат Флорида. Произведения немецких художников всегда пользуются здесь высоким спросом. Перед завершением выставки объявляется шорт-лист финалистов программы концерна BMW, спонсирующего начинающих художников.

    Автор: Наталия Королева, Сабине Ольце


 

Как работают хорошие комментарии к коммитам – SETRONICA

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

“Контекст! Контекст! Полцарства за контекст!”

Чем дольше вы работаете, в большем числе проектов участвуете, видите больше разного кода — тем выше шансы, что вы видели безобразные комментарии к коммитам. Вот часть лога из реальной кодовой базы:

Что это за правки? Почему они так ужасно отформатированы? Почему никто не попытался соблюсти хоть какой-то единый стиль кодовой базы? Кто виноват? “Однажды в далёкой-далёкой галактике мы что-то меняли в нашем коде…”.

Давайте сравним этот лог с недавними коммитами в Spring на Github:

Какие комментарии вам больше понравится читать? Какие — более чёткие и последовательные?

Грамотный комментарий к коммиту— это лучший способ рассказать коллегам о контексте изменений в коде. По диффам можно будет увидеть, что изменилось. Но только комментарий к коммиту расскажет, почему что-то изменилось.

Peter Hutterer однажды сказал:

Любое программное обеспечение — это командный проект. Там будет, как минимум, два разработчика: тот, кто написал исходный код, и тот же самый разработчик, но несколькими неделями или месяцами позже, когда поезд задумки уже давно покинул станцию отправления. Более поздний будет вынужден восстанавливать контекст для конкретной части кода каждый раз, когда появляется новый баг или нужно добавить новую фичу.

 

Восстанавливать контекст части кода — трудозатратно. Нам придётся это делать, так что давайте направим усилия на то, чтобы минимизировать эти трудозатраты, насколько это возможно. Комментарии к коммитам делают как раз это. В конечном счёте, они показывают, насколько разработчик способен к совместной работе.

Как выглядит хороший комментарий к коммиту

Точного определения идеального коммита не существует. Но мы в компании стараемся следовать известным best practices. Вот некоторые из них.

Три вопроса

Peter Hutterer говорит, что хороший комментарий к коммиту должен отвечать на три вопроса:

  • Почему этот коммит необходим? Это может быть исправление бага, добавление новой фичи, улучшение быстродействия, надёжности, стабильности, или просто правка, которую нужно сделать.
  • Как коммит решает задачу? Для небольших очевидных правок эту часть можно пропустить. Но даже в этом случае должно существовать высокоуровневое описание использованного подхода.
  • На что влияет эта правка? (Помимо очевидных эффектов, речь может идти о соответствии бенчмаркам, побочных эффектах и других последствиях)

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

Одно логическое изменение

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

Семь правил

Chris Beams выделяет семь правил для написания хороших комментариев к коммитам.

Обратите внимание: всё это уже было описано в разных источниках.

  1. Ставьте пустую строку между заголовком и описанием.
  2. Ограничьтесь 50 символами в заголовке.
  3. Пишите заголовок с большой буквы.
  4. Не ставьте точку в конце заголовка.
  5. Используйте повелительное наклонение в заголовке.
  6. Делайте переносы в описании после 72 символов в строке.
  7. Используйте описание, чтобы объяснить, что и почему, вместо как.

Например:

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

Если свести статью к одной фразе: используйте best practices, чтобы контролировать изменения в коде. Помните: вы не одни в проекте. Позаботьтесь об остальных.

Счастливо попрограммировать!

***
Автор:

Евгений Горбачёв,
Software Developer

Related

Новое основное меню, приватные комментарии и гибкая настройка оформления мобильного чата

После долгих новогодних праздников важно быстро и уверенно войти в рабочий режим. Поэтому в конце 2020-го мы выпустили несколько обновлений, которые помогут вам это сделать максимально комфортно: встречайте новое удобное левое меню и приватные комментарии в задачах по форме. А еще есть хорошие новости для тех, кто использует в своем приложении мобильный чат Pyrus для поддержки клиентов.

Обновленное левое меню

Чтобы вас ничего не отвлекало от работы, одна часть экрана в интерфейсе Пайруса теперь отдана только под текущие задачи, а в другой — компактно собраны все элементы управления и настройки.

Подробно обо всех изменениях в меню Пайруса читайте в этой статье.

Приватные комментарии в задачах по форме

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

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

Чтобы подключить заметки, зайдите во вкладку Расширения в настройках интерфейса (обратите внимание: он переехал в левый нижний угол экрана), выберите иконку Заметки и нужную форму. Готово!

Гибкая настройка дизайна мобильного чата

Если вы интегрировали мобильную библиотеку Pyrus Mobile Chat в своё приложение для поддержки клиентов, то это обновление вас порадует. Теперь вы сможете оформить мобильный чат так, чтобы он гармонично сочетался с дизайном вашего приложения. Настройте фон разного цвета для сообщений пользователей и вашей службы поддержки. Выберите нужные шрифты для заголовков и текста. Настройте внешний вид клавиатуры для ввода сообщения и цвета кнопок. Есть и модная тёмная тема оформления чата. Возможностей много, всё в ваших руках.

Подробно о том, как настроить оформление вашего мобильного чата, читайте в нашей справке:

настроить для iOS
настроить для Android

Если у вас остались вопросы по настройке или использованию наших декабрьских обновлений, задавайте их на [email protected], будем рады помочь.

Лучшие комментарии которые стоит прочесть — Первый блогерский

Я очень люблю читать комментарий, которые люди оставляют где-либо. Читая комментарии вы гарантированно улучшите свое настроение. А если еще удосужиться и написать нечто свое, то возможно, вы будете именно тем человеком которого будут долго цитировать и обсуждать.

Однажды я слушал музыку на ютубе, что то там лучшая музыка 2019… На фоне музыки были красивые девушки, яхты, машины, вобщем богатая, лакшери жизнь.

Вот это самое видео

https://www.youtube.com/watch?v=G0ep5EZFUrM

Комментарий под видео от ивана иванова:

Получая зарплату 17 000 руб проживая 4 человека в двухкомнатной квартире площадью 47 м3 после просмотра таких клипов хочетья спрыгнуть с пятого этажа сказав НАХУЙ ТАК ЖИТЬ

Не могу не вспомнить Виктора Федоровича Януковича, эту картинку вы наверное уже видели, так как этот случай мы уже обсуждали на первом блогерском в статье Синдром Януковича.

Из ВКонтакте, надпись над фото: Друзья, помогите найти девушку В БЕЛОМ, который день уже не могу найти… Буду признателен за любую информацию

Фото из ВКонтакте, надпись над фото: Просто хочу быть счастливой… Редко встречаться с бедой! Просто хочу быть любимой… Не оставаться одной… Просто хочу не лить слезы… от горести тяжких утрат… просто хочу держать розы… И чувствовать их аромат!

Фото из ВКонтакте, на странице пользователя Дениса Кушинского вызвавшее большой резонанс среди его друзей.

Иногда слова лишние.

Комментарий из ютуба.

Фото из ВКонтакте, на странице пользователя Геннадия Рыклина. Геннадий завел многих в ступор и недоумение.

Из того же ВКонтакте, достоверный пользователь точно не известен.

Немного логики, вопросы mail.ru. Какие невероятные версии люди выдвигают в этой казалось бы простой задачке. Необходимо было продолжить ряд чисел 1, 4, 9, 16

Вместо тысячи слов.

Фото из ВКонтакте, бабка в виртуальной реальности

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

>>> Как я в интернете вещи искал: подборка лучших объявлений

Как писать комментарии, которые выделяются (по правильным причинам)

Комментарии в блогах — это пережиток ушедшей эпохи.

Это слово на улице, не так ли?

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

Но это было тогда, правда?

Сегодня читатели обратились в Facebook и Instagram за исправлением комментариев.Спамеры и тролли захватили власть. В результате некоторые владельцы блогов сделали то, что когда-то было немыслимо: отключили свои комментарии.

Итак, игра окончена. Комментарии в блогах мертвы. Воткните в них вилку.

Верно?

Не так быстро.

В 2021 году писать хорошие комментарии проще, чем когда-либо, люди заметят

Умные блоггеры видят возможности там, где другие не видят.

Вот правда:

Поскольку многие отвергли комментирование в блогах как стратегию охвата, конкуренция практически отсутствует.

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

Но в разделе комментариев вы соревнуетесь со сверчками и перекати-поле. И некоторые из существующих комментариев имеют тенденцию к…

Что ж, они имеют тенденцию отстой.

И это досадно, потому что комментарии в блогах по-прежнему важны. Они по-прежнему могут привлечь внимание популярных блоггеров и влиятельных лиц.

Если — и в этом загвоздка — вы напишете качественный, действительно отличный комментарий в блог, который стоит заметить.

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

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

Реально?

Их комментарии, наверное, отстой.

Вот почему это проблема:

Неуклюжие комментаторы делают ужасные первые свидания

Комментарии в блогах во многом похожи на свидания.

Вы ведь пытаетесь ухаживать за другим человеком?

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

Комментируя блог, вы пытаетесь добиться расположения владельца блога.

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

Но возможно ли это, если ваши комментарии — отстой?

Конечно, это возможно

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

Но то, что это возможно, не означает, что это вероятно.

Вот почему пришло время улучшить вашу игру с комментариями.

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

Еще лучше: вы можете применить многие из этих советов к комментариям Facebook, комментариям Instagram, Twitter, информационным письмам и многому другому.

Давайте углубимся.

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

Распространенные ошибки, которые делают комментарии в блогах отстойными

Ошибка №1: Использование новинки (или несуществующей) Gravatar Image

Вы бы не стали Вы же не приходите на первое свидание в маскировке? Или носить простой бумажный пакет на голове?

Так почему бы вам выбрать изображение Сердитого Кота или Рона Бургунди, чтобы представлять вас в разделе комментариев в блогах людей? Или довольствоваться безликим силуэтом, который кричит «», «никто не »?

Вместо этого позвольте людям увидеть вас настоящего.

У них будет гораздо больше шансов почувствовать связь с вами, если они будут видеть ваше лицо.

Кроме того, ты знаешь, что ты сексуальный. Покажи нам эту улыбку!

Совет: Если ваше тщательно составленное сообщение каким-то образом помечено спам-фильтрами и хранится в чистилище (также известное как модерация комментариев), граватар увеличивает шансы, что владелец блога одобрит ваш новый комментарий.

Ошибка № 2: Использование вымышленного имени (или «забавного» псевдонима)

Среди ваших друзей и семьи вы можете выбрать Lil ‘Bit, DJ Roomba, Superfly, House of Shane или любой другой псевдоним, который вы выберите.

Но если вы не шпион или не защищаете свидетелей, вам следует использовать свое настоящее имя на первом свидании. (Если, конечно, это не свидание вслепую и Гэри Бьюзи не сядет за ваш стол.)

То же самое и с комментариями в блогах.

Блогеры, как и свидания, хотят знать, кто их пытается уговорить. А тот, кто оставляет анонимные комментарии и прячется за псевдонимом, скорее всего, не является долгосрочной перспективой.

Ошибка № 3: Выгрузка ссылок в ваших комментариях

Хотите, чтобы WordPress, Disqus или любая другая система комментирования знала, что вы не пишете спам-комментарии? Воздержитесь от встраивания ссылок в свои комментарии.

Представьте, что вы на свидании, и в середине вашего свидания внезапно спрашивает, есть ли у вас страхование жизни.

Вы пытаетесь отмахнуться, но они начинают обсуждать с вами тарифы и правила.

«О нет, — думаете вы про себя. «Это не свидание … это предложение о распродаже!»

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

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

Ошибка № 4: Невозможно прочитать сообщение перед тем, как комментировать

Когда-нибудь были на свидании с кем-то из Match или eHarmony, который не потрудился прочитать ваш профиль?

«Есть ли у вас хобби?» они будут спрашивать, несмотря на то, что в вашем профиле дань папье-маше, состоящая из тысячи слов. «Хотите сочный стейк?» они предложат, несмотря на то, что вы открыто заявляете о веганстве.

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

Знайте, что еще требует времени? Вытаскивать ногу изо рта.

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

Ошибка № 5: Гудение то и дело (и то)

Некоторым людям нравится звук собственного голоса. Спросите их, какая музыка им нравится, и они проведут вас в 12-минутном путешествии по деталям последнего альбома Джона Майера.

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

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

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

Комментарий из 500 слов не лучше комментария из 100 слов. Обычно это всего в пять раз дольше.

(И, вероятно, в пять раз скучнее.)

Ошибка № 6: Повторение того, что только что написано в сообщении

Когда-нибудь было свидание, на котором собеседник повторял все, что вы сказали?

Вы любите фильмы Кевина Костнера? Они тоже.

Вы обожаете мексиканскую кухню? Да, они тоже.

Ты ненавидишь понедельники? Они ненавидят понедельники.

Я называю этот вид попугая (re) Pete Comment .

Не добавляет к разговору. Он не задает вопросов. И это не бросает вызов идее.

Он просто повторяет сказанное в посте.

Подводить итоги можно, но ваш комментарий должен быть больше, чем версия CliffsNotes сообщения, которое вы только что прочитали.

Иначе какой в ​​этом смысл?

Четыре элемента хорошего комментария в блоге (плюс множество примеров)

  1. Дружеское приветствие
  2. Искренний комплимент
  3. Дополнительная ценность
  4. Прощальное обещание

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

С чего начинаются лучшие комментарии? Чем они заканчиваются? Что находится посередине?

Вот основные части, сверху вниз.

Деталь № 1: Дружеское приветствие

Первое, что я ищу, — это персонализация. Это так просто, достаточно просто указать имя автора. Адам Коннелл

Давайте вернемся к нашей аналогии со свиданиями …

Вы встречаетесь со своим красивым парнем или красивой девушкой в ​​ресторане на первом свидании. Могли ли они быть единственными? Они не выглядят сумасшедшими или что-то в этом роде.

С надеждой вы делаете глубокий вдох, улыбаетесь и здороваетесь.

Но вместо того, чтобы поприветствовать вас или даже поблагодарить вас, ваша пара просто начинает говорить.

Без преамбулы — они сразу начинают говорить о своем дне.

Вы знали, что у них есть сослуживец по имени мистер Баттонс? Вы знали, что у них аллергия на арахис?

Теперь поймешь.

Памятная дата? Я предполагаю.

Свидание, которое вы хотели бы узнать получше? Точно нет.

И тем не менее, каждый день пишутся тысячи комментариев, в которых никоим образом не упоминается автор сообщения.

Считают ли они, что сообщение написали роботы, а не человек? Считают ли они, что приветствия — устаревший ритуал? Или им просто лень прокручивать назад вверх, чтобы найти имя автора?

Если вы надеетесь привлечь внимание блоггеров и завязать отношения, здоровая доза правильного этикета может иметь большое значение.

Так что передай им привет.

Поприветствуйте их.

Обращайтесь к ним по имени.

Как это сделать

Это настолько просто, что не требует объяснений. Но вот как это сделать в любом случае.

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

Затем скажите привет . Или привет . Или , привет, , если тебе нехорошо.

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

Время, проведенное не зря.

Часть № 2: Искренний комплимент

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

Вы впервые встречаетесь со своим свиданием.

«Вау! «Мне нравится твой наряд», — скажете вы.

Или: «Мне очень нравится твоя машина».

Или даже: «У тебя потрясающая татуировка Губка Боб!»

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

И снова комментирование в блогах ничем не отличается.

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

Скорее всего, они вам нравятся. Вы их цените.Вы их уважаете.

Так что сделайте им комплимент…

Скажите им, насколько вам понравилась их замечательная статья…

Сделайте их день…

Короче говоря, сделайте им комплимент. Любой комплимент. Просто убедитесь, что это искренний комплимент.

Как это сделать

Вы можете сосредоточиться на блоггере, самом сообщении или их комбинации.

Вы поклонник творчества блоггера? Скажи им об этом.Скажите, насколько вам нравится их письмо.

Еще лучше? Расскажите им о конкретном примере, когда их тексты помогли вам.

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

Изменило ли это ваше отношение к теме? Или, может быть, это побудило вас выйти и принять меры? Это потрясло ваш мир?

Скажите им об этом.

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

(К тому же, вы не хотите выглядеть жутким преследователем.)

Часть № 3: Дополнительная ценность

Мои любимые комментарии добавляют дополнительную ценность посту. Возможно, они добавляют личный опыт, другую точку зрения или новый вопрос.Henneke Duistermaat

Теперь мы перейдем к сути того, что дает хороший комментарий хороший .

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

Ваша цель в каждом комментарии должна заключаться в добавлении ценности. Если ваш комментарий не добавляет ценности, вы тратите время зря.

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

Что это на самом деле означает?

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

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

Вы делаете это, производя положительное впечатление, а затем опираясь на него.

Вот как это сделать:

Ценностная тактика №1: поделитесь личными наблюдениями или анекдотами

Удалось ли вам конкретный момент в сообщении? Вы нашли что-то особенно близкое? Или сообщение затронуло область, в которой вы испытываете трудности?

Если вы поделитесь личным мнением, блоггерам будет проще найти вас.Вы больше не просто незнакомое имя, оставляющее комментарий, который мог оставить кто угодно…

Вы блоггер с историей!

Как это сделать

Не беспокойтесь о ченнелинге Германа Мелвилла; Помните, что хорошие комментарии не должны длиться долго, чтобы быть эффективными.

Аманда Формаро прекрасно демонстрирует это в своем кратком комментарии о подписчиках электронной почты.

В том же обсуждении Дженн устанавливает связь, делясь своими проблемами.

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

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

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

Ценностная тактика № 2: задавайте вдумчивые вопросы

Была ли в сообщении представлена ​​идея, которую вы не до конца поняли? Может быть, вы хотите, чтобы автор подробно остановился на каком-то моменте?

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

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

Как это сделать

Эндрю Уорнер отправился на поиски после прочтения тематического исследования трафика блога Андрианеса Пинантоана:

Пуджа, отличный писатель сама по себе, сделала то же самое после прочтения поста Глена Лонга о кристально чистом письме:

И Гертруда Нонтера, прочитав мой пост об основных этапах ведения блога, воспользовалась возможностью, чтобы задать ей вопрос, который давил на нее:

Иногда для краткости автор не может полностью конкретизировать детали в его или ее сообщение в блоге.

Так что, если статья содержала подробности, которые вы хотели бы раскрыть, не бойтесь комментировать и спрашивать.

Ценностная тактика № 3: Участвуйте в обсуждении
Если вы хотите привлечь внимание влиятельных лиц и владельцев блогов, ваш комментарий должен добавить к разговору. Сью Энн Данлеви

В сообщении было представлено 581 чувственное слово, но вы знаете хорошее для # 582? Хотите конкретизировать тему, обсуждаемую в посте, о поиске работы внештатного писателя? Как насчет детали, о которой вообще не было?

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

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

В результате больше людей читают и обсуждают работу блоггера, что означает большее количество комментариев.

Блогерам это нравится — и им нравятся комментаторы, которые помогают в этом.

Как это сделать

Прекрасным примером этого является следующий комментарий Энн Р.Аллен оставил Брайана Дина в своем информационном посте для блоггеров здесь, в Smart Blogger:

Еще один комментарий, который Харлина Сингх оставила Уиллу Блант:

И один из лучших примеров, который вы когда-либо видели, — это комментарий, оставленный Мэтью Хардингом. Сообщение Smart Blogger об основных этапах ведения блога. Вот фрагмент:

Когда вы добавляете ценность хорошим комментарием, вы инвестируете в сообщение в блоге.

Блогерам это нравится. Они это ценят…

Они учатся на нем…

И они это помнят.

Часть № 4: Обещание прощения

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

Этой подсказкой может быть долгая улыбка. Это могло быть случайным замечанием об отсутствии каких-либо планов на следующую субботу.Или это может быть другой человек, который на самом деле говорит: «Мне понравилось, и я хотел бы увидеть вас снова».

Какую бы форму он ни принял, он посылает сообщение: эта дата не была единовременной.

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

Вот почему лучшие комментарии обещают в конце. Они говорят блоггерам: «Эй… Мне так понравилось, что я хочу, чтобы вечеринка продолжалась!»

Как это сделать

Отличный способ дать обещание — сказать автору, что вы собираетесь поделиться постом в своей любимой социальной сети…

Скажите им, что они написали такой хороший пост, что вы у меня нет выбора, НО поделиться им…

Или направить своего внутреннего Арнольда Шварценеггера и сказать им: «Я вернусь» (чтобы прочитать больше вашего контента)…

Но какое бы обещание вы ни дали, будьте уверены чтобы сохранить это.

Напишите сообщение в Твиттере, как вы и обещали. Прочтите другие сообщения блоггера и оставьте больше комментариев. Другими словами, делайте именно то, что обещали.

И когда вы поделитесь публикацией в своей любимой социальной сети, обязательно отметьте блоггера — дайте им знать, что вы выполнили…

И если блоггеры чем-то похожи на Уилла Хукенгу, они заметят и выразят свое благодарность…

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

Итак, как выглядит хороший комментарий, в котором есть каждый из этих элементов?

Это очень похоже на этот комментарий от Адриенны Смит:


И очень похоже на этот комментарий от Айодеджи Авосика:

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

Но помимо этого, они добавляют дополнительный элемент, присутствующий в большинстве хороших комментариев…

Личность.

Любой робот может начать комментарий с приветствия и закончить его обещанием.

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

Как однажды сказал мне мой друг Хайме Бакли:

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

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

Хайме пишет свои комментарии так, как он пишет электронное письмо другу.

Это освежает и отличный способ привлечь внимание.

Богатые награды, которые вытекают из тщательно продуманных комментариев

На этом этапе вам может быть интересно…

Стоит ли оно того?

Стоит ли тратить все это время и мысли на комментарии в блоге?

Для меня это того стоило.

Несколько лет назад я оставил следующий комментарий к сообщению, опубликованному на этом же веб-сайте, Smart Blogger:

Я поприветствовал автора по имени, похвалил его работу, добавил ценность и пообещал поделиться своим постом о том, что сейчас … несуществующий Google Plus.

Неделю спустя, после того как Smart Blogger опубликовал новый пост, я оставил еще один комментарий:

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

На следующей неделе я сделал это снова:

И снова на следующей неделе.И следующее. Снова и снова, снова и снова.

Каждую неделю, неделю за неделей, я посещал Smart Blogger, читал их последний шедевр и оставлял им хорошие комментарии.

Редактор Smart Blogger в то время, Глен Лонг, обратил внимание:

Несколько месяцев спустя Глен пригласил меня стать приглашенным писателем:

Это приглашение привело к моей первой публикации для Smart Blogger…


… что привело к еще нескольким.

Перенесемся на несколько лет вперед, и Джон Морроу, генеральный директор компании, пригласил меня присоединиться к Smart Blogger в качестве его главного редактора.

Сегодня я веду блог, которым восхищался и за которым следил много лет. Я работаю вместе со своими наставниками Джоном и Гленом. Я смогу осуществить свою мечту — бросить крысиные бега и вести блог на полную ставку.

И у меня есть комментарии, которые я хочу поблагодарить за приведение колес в движение:

Ваш пробег может варьироваться.

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

Давайте узнаем, куда вас могут привести хорошие комментарии

Этого не произойдет в одночасье. И ясно, что одни только хорошие комментарии не катапультируют вас к мировому господству.

Но они — эффективный компонент, о котором часто забывают, особенно сейчас, когда так много блоггеров думают, что они прошли путь дронта.

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

Они способны заставить влиятельных блоггеров сесть, обратить внимание и спросить себя: «Кто это ?

Итак, вы готовы к новой эре умного комментирования?

Готовы ли вы узнать, куда могут вас привести хорошие комментарии?

Тогда займемся этим.

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

Вставьте эту инфографику на свой сайт:


Как писать комментарии, которые выделяются (по правильным причинам) на SmartBlogger.com

Почему хорошие коды не нуждаются в комментариях | Автор: Нам Нгуен

Я призываю вас внимательно ознакомиться с двумя следующими фрагментами кода

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

Вот что подумают ваши коллеги, оценивая приведенный выше код, если вы тот, кто его написал

  • Почему он должен был сказать это вслух? Он полагал, что его читатели кода отсталые?
  • В чем смысл этой строки комментария? Есть ли скрытый смысл?
  • Почему он все еще использовал один символ для имен переменных? В каком году люди это практикуют?

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

Фото Брюса Марса на Unsplash

А теперь еще раз внимательно рассмотрим второй фрагмент кода. Считаете ли вы, что код говорит сам за себя? Никаких объяснений не требуется.

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

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

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

У хороших кодов есть ритм, в то время как у посредственных кодов много пауз

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

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

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

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

Один-единственный плохой комментарий может стать нечитаемым и озадачить ваших коллег или даже вашего будущего.

Представьте, что кто-то оставил такой комментарий три года назад

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

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

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

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

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

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

Фотография Мими Тиан на Unsplash

Вам следует перейти к делу. Все, что они хотят знать, — это как работает ваша программа и как ее использовать. Говорите прямо, ясно и кратко. Хорошее общение не требует общения.

Это был я после одного хорошего часа кодирования

А это я после того, как избавился от плохих комментариев

Человеческий мозг ленив по своей природе. Он стремится использовать наименее устрашающий способ выполнения задач.

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

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

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

Комментирование — это контрпродуктивный способ начать программировать.
Сначала черновик, потом редактировать.

Мы говорили об отвлечениях, иногда даже хуже. Некоторые комментарии более вредны, чем другие.

Рецензенты вашего кода не умеют читать мысли. Они могут свободно разбираться в коде, и он может отличаться от вашего.

Когда вы и ваши соавторы не на одной странице, программа может сделать большой поворот. Его можно использовать для того, для чего он изначально не был предназначен.

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

Никто никого не понимает с плохими комментариями. Будет светиться только код, и это то, на чем вам стоит сосредоточиться.

Мой личный выбор самых забавных комментариев, которые существуют в исходном коде

 / * 
* Уважаемый специалист по обслуживанию
*
* Как только вы закончите попытки «оптимизировать» эту процедуру,
*, и вы поняли, какая ужасная ошибка, было,
* пожалуйста, увеличьте следующий счетчик как предупреждение
* следующему парню.
*
* total_hours_wasted_here = 73
*
* необъявленная переменная, ошибка в строке 0
*
* /

Хороший комментарий — лучшее руководство по его написанию

0

В современном мире социальных сетей становится все труднее найти хороший комментарий.

Сразу можно подумать: «Эй, я умею писать хороший комментарий!» — и я уверен, что да, в ваших собственных глазах. Все думают, что они великолепно пишут комментарии.Но так ли это на самом деле?

Я получаю достаточно много комментариев об этом и других моих блогах. Не все из них можно опубликовать. Почему? Потому что они не на высоте. Другими словами, большинство из них неадекватны.

Погодите, это еще одно безумное заявление! Но я обнаружил, что после того, как в 2014 году перестали оставлять комментарии в социальных сетях, уровень взаимодействия и вовлеченности значительно снизился.

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

Но ведь комментарии — это естественная реакция?

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

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

Может быть, это потому, что они слишком заняты и у них нет времени. Им не хватает как писательских, так и социальных (!) Навыков. Или вы не понимаете истинных причин взаимодействия и того, как взаимодействие с друзьями, подписчиками или даже вашими клиентами может быть полезным.

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

Эй, вы ходили в школу, чтобы научиться писать, не так ли? Но сколько ваших учителей научили вас комментировать? А если да, то не могли бы вы заверить, что они сами делали это достаточно регулярно и по правильным причинам?

Какие элементы хорошего комментария?

Начнем с того, что нужно добавить в ваш комментарий.Очевидно, должны быть начало, середина и конец. И все же так много комментариев не содержат этого! Почему?

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

Очень редко комментатор останавливается, думает и обдумывает то, что нужно сказать. Этот процесс препятствует мгновенным ответам.И на самом деле отражение влияния комментария на других и на автора очень редко приходит в голову.

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

  

А вот код, который вы можете вставить в свои собственные сообщения (в текстовом режиме), если хотите поделиться этой инфографикой со своими читателями.

Передай привет

Если бы вы увидели на улице кого-то, с кем хотели бы поговорить, но не видели его довольно долгое время, вы бы подошли к нему и сразу перешли к тому, что хотели сказать?

И все же, почему это считается приемлемым в комментариях? Неужели мы забыли о своей социальной привлекательности только потому, что находимся в сети? Делает ли нас, прячась за экраном, мгновенно узнаваемыми, заметными и симпатичными? Едва ли!

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

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

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

Скажи что-нибудь приятное

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

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

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

Простым примером может быть: «Спасибо за такой отличный пост, он определенно открыл мне глаза на [предмет].» Это может быть наиболее приемлемым способом начать ваш комментарий.

Комментарий Жаклин ниже показывает как приветствие, так и подходящее приветственное вступление:

Покажите, что вы понимаете

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

Ну это в идеале.Но так бывает не всегда.

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

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

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

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

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

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

Хороший комментарий дает значение

Теперь мы подошли к комментарию «мясо и два овоща».Основная причина, по которой вы вообще хотели высказать свое мнение.

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

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

Четвертый и основной раздел хорошего комментария должен быть таким же вдохновляющим, как и пост, который его стимулировал. Если есть вопрос, ответьте на него. Есть проблема? Вы могли бы предложить решение. Предложите исправление (полезным способом) любой информации, которая может быть неправильной.

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

Джин больше всего готов поделиться своим мнением:

Обещаю действие

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

В письме можно написать «Искренне Ваш», но подходит ли это для комментария? Другие послания могут заканчиваться словами «С любовью и поцелуями», но это может не соответствовать стилю и теме того, о чем вы пишете.Но даже простая подпись своим именем может иметь значение.

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

Если вы что-то узнали из поста, так и скажите. Расскажите автору, что вы собираетесь делать со своими новыми знаниями и как это улучшит вашу жизнь, бизнес или что-то еще.Всегда полезно знать, какая информация полезна, полезна и даже применима.

Мелина закончила свой комментарий, рассказав мне, что вдохновило ее на чтение моего сообщения:

Хорошая техника комментирования

Теперь у нас есть пять разделов для написания хорошего комментария, пора переходить к более сложным вещам.

Вот шесть приемов, которые вы можете принять во внимание, когда захотите написать хороший комментарий.Они объяснены в инфографике ниже:

  

А вот код, который вы можете вставить в свои собственные сообщения (в текстовом режиме), если хотите поделиться этой инфографикой со своими читателями.

Вы действительно его читали?

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

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

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

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

Простота — ключ к успеху

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

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

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

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

Добавить личный элемент

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

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

Сложные концепции лучше объяснить анекдотами или шутками. Юмор и смех помогают преодолевать преграды. Объедините свое сообщение с изображениями, такими как мультфильмы, мемы и гифки, чтобы его было легче понять.

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

Комментарии моего хорошего друга Фила всегда отражают его личность, и их приятно получить:

Если сомневаетесь, спросите

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

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

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

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

Трейси-Джейн была заинтригована тем, что я упомянул, и задала вопрос, чтобы узнать больше:

Вопрос Фила является продолжением темы, которую он поднял. Это фактически привело к другому сообщению в блоге от меня:

Это было сказано раньше?

Релевантность — чрезвычайно важный фактор при комментировании. Я не могу подчеркнуть это достаточно. Так много плохих комментаторов, в частности спамеров и троллей, печально известны тем, что не придерживаются темы и говорят только о том, о чем они хотят написать.

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

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

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

Иди первым!

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

Еще одно соображение — установить сцену. Быть первым, кто прокомментировал пост, означает, что у вас есть карт-бланш на то, что вы можете сказать, и никто другой вам не мешает. Это также означает, что ваш вклад получит полное и безраздельное внимание автора.

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

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

Вопрос Гордона в его комментарии (ниже) был наиболее уместным, поскольку добавление комментария или просьба друга написать его для вас сломают утку комментирования, что может быть очень неприятным для многих потенциальных комментаторов.

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

Что никогда не повлияет на хороший комментарий?

Да, есть некоторые вещи, которые вы не должны делать при написании комментария, хорошего, плохого или уродливого.

Люди, которые совершают эти зверства, обычно плохо разбираются в комментариях. Итак, я создал инфографику, чтобы показать вам, чего следует избегать:

  

А вот код, который вы можете вставить в свои собственные сообщения (в текстовом режиме), если хотите поделиться этой инфографикой со своими читателями.

Хороший комментарий никогда не продвигает

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

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

Тем не менее, я получаю много комментариев, содержащих внешние ссылки. Ссылка обычно не имеет отношения к теме сообщения. Поэтому я оцениваю ценность содержания комментария и, если оно достаточно хорошее, редактирую его, удаляя ссылку перед публикацией и ответом на нее (см. Ниже). Все остальные материалы переводятся в папку для спама.

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

А вот и спам-комментарий со ссылкой, которая отправится прямиком в корзину:

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

Перестань забегать вперед

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

Социальные сети — это открытая площадка для комментирования с ограниченной модерацией (проверкой). Это не обязательно хорошо. Каждому Тому, Дику и Харриет дается полная свобода говорить то, что они хотят, и многие из них публикуются без особого внимания к тем, кто их читает.

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

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

Пол из SideGains прекрасно это понимает:

Не забывайте придерживаться темы

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

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

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

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

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

Всегда вежливость и уважение

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

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

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

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

Кто ты? Мы не можем сказать

Если вы посмотрите на приведенный выше пример комментария, вы заметите, что они используют свой бизнес, а не имя человека.Если вы посмотрите комментарий Альберта Давида выше, вы увидите, что он использует свой логотип, а не собственное имя. Что это говорит вам о том, кто комментирует? Немного.

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

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

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

Как видите, Лиза делает все возможное, чтобы получить хороший комментарий:

Готовы написать хороший комментарий?

Перечитайте этот пост еще раз (как следует), а затем выделите время в своем дневнике, чтобы сделать некоторые комментарии. Эту деятельность следует выполнять не на лету, а с должным вниманием к конечной цели.

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

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

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

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

Алиса Эллиотт, также известная как «Мать блога фей», стремится рассказать миру о преимуществах комментирования, взаимодействия и взаимодействия как для частных лиц, так и для предприятий.

Последние сообщения от Alice Elliott (посмотреть все)

Хорошие или плохие комментарии в блогах?

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

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

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

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

5 преимуществ комментариев в блоге

Давайте начнем с рассмотрения некоторых основных преимуществ комментариев на вашем веб-сайте.

1. Может отображать социальное доказательство

Может оказаться полезным наличие на вашем сайте своего рода «социального доказательства».

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

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

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

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

2. Может увеличить время на сайте и увеличить количество повторных посещений

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

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

Это может привести к улучшению показателей вовлеченности вашего сайта.

3. Помогите вам узнать своих читателей и создать сообщество

Если вы отвечаете на комментарии, оставленные в своем блоге, у этого есть несколько преимуществ.

Например, это показывает, что вы настоящий человек. Многие люди предпочитают общаться с другими людьми в Интернете, а не с брендами, которые часто являются безликими сущностями.

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

При этом, если у вас есть активное сообщество на Facebook или Twitter, вы можете отвлечь внимание посетителей оттуда, а не на раздел комментариев.

4. Вы получаете новые идеи содержания

Я часто черпал идеи для нового содержания из комментариев в блогах.

Иногда комментарии — это вопросы, которые действительно требуют правильного ответа на весь пост.

5. Хорошие комментарии сделают информацию на ваших страницах более полной

Многие люди предпочитают оставлять отзывы в комментариях.

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

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

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

Например, я недавно написал статью о 7 бесплатных инструментах SEO от Google.Кто-то оставил комментарий с 6 дополнительными инструментами, о некоторых из которых я даже не знал.

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

5 негативов комментариев в блоге

Вот некоторые из наиболее часто упоминаемых недостатков комментариев в блогах.

1. Разделы комментариев привлекают много спама

Комментарии обычно привлекают много спама.

Если ваш сайт использует стандартную систему комментариев WordPress без эффективной защиты от спама, то он может привлекать десятки или даже сотни спам-комментариев в день .

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

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

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

Я использую стороннюю систему комментирования Disqus. Он очень эффективен при удалении спама, поэтому для меня это не проблема.

2. Может потребовать много времени и энергии

Если у вас небольшой блог, в котором не так много комментариев, то чтение и ответ на них, вероятно, не займет много времени.

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

На моем старом сайте (который я продал в 2017 году) я получал сотни комментариев к некоторым статьям.

У меня не было возможности ответить на все вопросы, и мне даже пришлось делегировать модерацию комментариев другим людям.

Комментарии отнимают еще больше времени (и энергии), если вы склонны ввязываться в споры.

Для меня, если я ввязываюсь в спор в Интернете, это, как правило, доминирует над моим вниманием.

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

По этой причине я больше не ввязываюсь в споры в Интернете (за исключением случаев, когда это случается случайно). Это не стоит ни времени, ни энергии.

3. Многие разделы комментариев очень токсичны.

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

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

4. Комментарии могут усложнить ваш бизнес

Модерирование комментариев может усложнить вашу работу.

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

5. Может замедлить работу вашего сайта

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

Если вы используете стандартную систему комментариев WordPress, то комментарии добавляются в базовый html-файл вашего сайта.

Это первый файл, который загружают посетители при посещении страницы вашего сайта. Он содержит ваш базовый html-код, ваш контент и комментарии.

Если этот файл большой из-за большого количества комментариев, это может заметно повлиять на скорость и отзывчивость вашего сайта.

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

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

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

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

Итог: Модерация комментариев может занять много времени и энергии и усложнить вашу работу. В зависимости от технических настроек комментарии также могут значительно замедлить работу вашего сайта.

Хорошие или плохие комментарии для SEO?

Многие люди задаются вопросом, хороши или плохи комментарии в блогах для SEO-производительности их сайтов.

Если вы посмотрите на сайты с самым высоким рейтингом, то четкой закономерности нет. На некоторых сайтах есть комментарии, на других — нет.

Хотя мне не удалось найти никаких недавних исследований, исследование, проведенное Hubspot в 2011 году, обнаружило очень слабую корреляцию между количеством комментариев в блогах и количеством просмотров.

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

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

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

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

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

И наоборот, если ваши комментарии некачественные, токсичные или пронизаны спамом, то эти комментарии, вероятно, вредны для SEO.

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

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

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

В глазах Google комментарии — это часть содержания на странице.

Таким образом, если ваши комментарии низкого качества, это потенциально может снизить общее качество ваших страниц и снизить эффективность вашего сайта в поиске.

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

Итог: Вероятно, это зависит от сайта и качества комментариев, хороши они или плохи для SEO.Google рассматривает контент, создаваемый пользователями, например комментарии, как часть контента на странице, поэтому качество имеет решающее значение.

Комментарии необходимо обрабатывать

Учитывая, что Google рассматривает комментарии как часть вашего содержания, вы обязательно должны тщательно управлять разделом комментариев.

Вот что вам следует сделать:

  • Ссылки на комментарии Nofollow: Убедитесь, что все ссылки в ваших комментариях не являются читаемыми, чтобы они не передавали никакой ценности для SEO. Скорее всего, это включено по умолчанию.
  • Отключить домашнюю страницу: Рассмотрите возможность удаления опции, позволяющей комментаторам оставлять URL-адреса своих домашних страниц. Это магнит для спама и битых ссылок.
  • Удалить спам: Вам обязательно нужно удалить все спам-комментарии. Если спам останется на вашем сайте, это может стать катастрофой.
  • Комментарии низкого качества: Удалите комментарии, такие как «Хороший пост» и «Спасибо!», А также комментарии, которые плохо отформатированы с большим количеством орфографических и грамматических ошибок.
  • Грубые и ядовитые комментарии: Тролли и грубые люди должны быть запрещены.Работа с ними не стоит вашего времени или энергии.

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

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

Как я максимизирую преимущества и минимизирую недостатки

Мне нравится оставлять комментарии на моем сайте, потому что я думаю, что они могут принести пользу моим читателям.

После долгих экспериментов я нашел способы максимизировать преимущества комментариев при минимизации негативов.

Я делаю это с помощью сторонней системы комментирования Disqus. Затем я использую бесплатный плагин Disqus Conditional Load, который я настроил для загрузки комментариев Disqus только тогда, когда люди нажимают кнопку «Показать комментарии».

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

Кроме того, похоже, что Google не сканирует мой раздел комментариев и в основном игнорирует его содержание.Это то, что я предпочитаю.

Вы также можете отложить загрузку стандартной системы комментариев WordPress с помощью бесплатного плагина Lazy Load for Comments.

Итог: Я использую стороннюю систему комментирования Disqus и использую плагин для загрузки комментариев только тогда, когда посетители нажимают кнопку. Это избавляет почти от всего спама и гарантирует, что комментарии не замедлят работу моего сайта.

Если у вас есть комментарии к вашему блогу?

Вот простой способ решить, оставлять ли комментарии в своем блоге:

  1. Если вы считаете, что комментарии делают ваш сайт лучше и приносят пользу вашим читателям, сохраните их.
  2. Если вы не думаете, что они приносят пользу, избавьтесь от них.
  3. Если комментарии снижают ваше собственное качество жизни на , определенно избавьтесь от них.

В конце концов, комментарии бывают ни хорошими, ни плохими. Это зависит от сайта, тематики, читателей и личных предпочтений владельца сайта.

Но если вы решите сохранить их, внимательно относитесь к комментариям, чтобы они не снижали общее качество вашего сайта.

Вы слишком много комментируете свой код (и другие противоречивые мысли о документации) | by Bennett Garner

Код с чрезмерными комментариями часто труднее понять, чем код без комментариев.

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

Конечно, бывают исключения! Я не говорю, что вы * никогда * не должны писать комментарии.

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

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

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

НО те времена немногочисленны и далеки друг от друга.

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

Хорошее и полезное правило. Но это не решает полностью проблему чрезмерного комментирования.Любой, кто когда-либо проводил время с малышом, знает, что вы можете спросить: «Почему?» в бесконечном цикле.

Вы можете спросить, почему что-то в вашем коде, но это не значит, что вы должны все комментировать. Итак, вам нужно более строгое правило, когда следует добавлять комментарии. Моя философия:

Пишите комментарий только тогда, когда его невозможно избежать.

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

Но комментарии — не единственный способ объяснить ваш код. Давайте посмотрим, что я имею в виду.

Самое большое правило исключения комментариев — не делать что-то вроде этого:

 # Вложенные циклы for для перебора значений для i в outer_loop: 
for j в inner_loop:
do something

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

Вот код, который я написал, когда впервые изучал мою точку зрения:

 / * Используйте деление / умножение по модулю и основанию 10, чтобы перевернуть 
* int * / while (original> 0) {
reverse * = 10 ;
int r = исходный% 10;
реверс + = г;
оригинал / = 10;
}

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

Лучший способ удалить такой комментарий — это использовать правильное имя для ваших переменных и поместить код внутри хорошо названной функции, например reverse_int ()

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

Однако есть еще одна необходимая работа. Документация — одна из составляющих этого. Правильное документирование кода делает его легко обслуживаемым и понятным.

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

Вот код, который я написал недавно, с гораздо меньшим количеством комментариев, но с лучшими названиями функций и понятным кодом:

 unsigned int sum_squares (int m) {
int i;
целых квадратов = 0; for (i = 0; i <= m; i ++) {
квадратов + = i * i;
} вернуть квадраты;
} / * Квадратичный, поэтому может достигать миллиардов.Используйте long long. * /
unsigned long long square_sums (int n) {
int j;
int sum; для (j = 0; j <= n; j ++) {
сумма + = j;
}

возврат сумма * сумма;
}

(Полностью открыт для исправлений моего кода C. Ни в коем случае не эксперт!)

Однако вы можете видеть, что в этом коде только один однострочный комментарий. Это объясняет, ПОЧЕМУ нам нужно больше памяти для возврата square_sums () .

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

Редко упоминается то, что комментарии тоже нужно сохранять!

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

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

Еще одна причина свести комментарии к минимуму.

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

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

Я что-то пропустил? Я совершенно не понимаю, как работает ваш рабочий процесс кодирования и как вы используете комментарии?

Подскажите в комментариях ниже!

Если вам понравилась эта статья, это будет много значить, если вы аплодируете и последите за мной. Регулярно пишу новые посты.

100 Табель успеваемости Комментарии, которые вы можете использовать сейчас

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

Вот несколько общих принципов табеля успеваемости, за которыми следует мой удобный список редактируемых фраз…

Три принципа табеля успеваемости

1. Будьте правдивы, но добры

Основная цель табеля успеваемости — информировать родителей об успеваемости их ребенка. Хотя серьезных сюрпризов быть не должно (БОЛЬШИЕ вопросы уже должны были быть обсуждены с родителями ребенка), независимо от того, насколько хорошо ребенок успевает или насколько плохо, табель успеваемости должен честно отражать его успеваемость.

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

2. Следуйте магическому формату

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

А. Начните с комплимента … вам, возможно, придется копнуть здесь глубже, но проявить творческий подход, оставаясь искренним (ладно, иногда вам действительно придется тянуться к одному, не буду лгать). А если серьезно, то у каждого ребенка есть качества, которые мы можем похвалить, даже у самых сложных детей.

B. Затем добавьте пару строк о том, что вызывает у ребенка трудности, как он / она борется в определенной области, и обязательно предлагайте решение или предложение, которое является практичным и полезным.

С. Закончите на положительной ноте. Опять же, комплимент — это приятный штрих в любое время года и для табеля успеваемости на конец года, наилучшие пожелания в ____ классе или прекрасного лета, или я так рада, что была учителем ____ в этом году, и так далее работает хорошо.

3. Вычитка, проверка и повторная вычитка

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

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

Теперь, когда принципы не мешают, вот мой список из 100 комментариев в табеле успеваемости. Я попытался включить самые разные комментарии по поводу самых разных уровней способностей и поведенческих проблем детей, которым мы обучаем в наших классах.
  1. Мне очень понравилось быть учителем _ , и в следующем году я буду скучать по нему.
  2. _ показывает хорошие / отличные / выдающиеся успехи в оценке.
  3. _ проделал (n) / фантастическую / образцовую / замечательную работу в этом году в классе _ и работал очень много.
  4. Я ценю _ качественную работу / мотивацию к успеху / отношение и мне нравится быть его / ее учителем.
  5. _ умен, но работает ниже своих возможностей / потенциала из-за отсутствия мотивации / внимания к качественной работе.
  6. _ преуспевает в любой задаче, к которой он / она задумывается.
  7. Я так горжусь _ и желаю ему / ей успехов в учебе и выше.
  8. _ очень много работал в этом году, и я горжусь всеми его достижениями.
  9. _ повысил квалификацию в _ .
  10. _ уважительно относится к своим одноклассникам и очень популярен.
  11. Меня беспокоят организационные навыки _ и его / ее ответственность за своевременную сдачу заданий.
  12. _ устанавливает для себя высокие стандарты и достигает их.
  13. _ услужливый и добрый человек, с которым приятно находиться.
  14. _ преуспел во многих областях, но я обеспокоен тем, что его / ее недостаток умения слушать / сосредотачиваться / мотивация и следовать указаниям / работать независимо / работать спокойно, способствовал его более низкой оценке в _ .
  15. _ добился хороших / отличных / выдающихся успехов во всех академических областях.
  16. _ умен, целеустремлен и трудолюбив и может гордиться своими достижениями в этом году.
  17. К сожалению, для оценок _ были пропущены задания.
  18. _ завоевывает доверие к _ , но выиграет от _ .
  19. _ последовательно следует правилам класса и является хорошим образцом для подражания.
  20. Пожалуйста, поощряйте _ к _ каждый день, чтобы помочь ему / ей стать лучше в _ .
  21. _ позитивно настроен, и учить его — радость.
  22. _ кажется, что _ кажется сложным, и было бы полезно читать по вечерам / практиковать математические факты / работать в Интернете…
  23. _ — потрясающий / замечательный / потрясающий оценщик, и мне понравилось узнавать его / ее в этом году.
  24. _ способен получить более высокую оценку, но ему необходимо _, чтобы добиться прогресса.
  25. _ выделяется в творчестве / повествовании / написании мнений.
  26. _ создает хорошо организованные / хорошо разработанные рассказы / эссе / абзацы.
  27. _ обладает хорошими навыками понимания прочитанного.
  28. У
  29. иногда возникают трудности с пониманием прочитанного, и ему будет лучше _ .
  30. _ значительно улучшился в области _ .
  31. _ хорошо работает с другими студентами.
  32. _ не только хорошо работает со своими одноклассниками, но и является естественным лидером.
  33. _ внутренне мотивирован и стремится доставить удовольствие.
  34. _ в целом в этом году делает отличную / выдающуюся / замечательную / фантастическую / отличную работу.
  35. _ любит участвовать в классных уроках, и его / ее базовые знания очень помогают в наших обсуждениях.
  36. _ очень сострадателен и всегда добр к другим.
  37. _ — ученик с творческими способностями, и мне нравилось видеть прекрасные писательские / художественные проекты / рисунки, которые он / она создал / написал.
  38. _ находится в задаче независимо от активности.
  39. _ , кажется, любит школу, и его позитивное отношение делает наш класс ярче.
  40. _ внимательно слушает указания, и я ценю его / ее способность сразу же приступить к работе.
  41. _ — очень вежливый ученик, и преподавать с ним одно удовольствие.
  42. _ борется за соблюдение правил в классе, и ему необходимо сосредоточиться на тихой работе / пребывании на своем месте…
  43. _ очень разговорчив в тихие периоды работы и отвлекает окружающих.
  44. Работать тихо для _ очень сложно, и я хотел бы, чтобы он / она сосредоточился на своей работе, чтобы он / она, а также другие люди вокруг него / нее могли заниматься поставленной задачей / учиться эффективнее…
  45. _ отличается превосходным отношением к делу и всегда готов помочь.
  46. _ — прекрасный помощник и руководитель класса.
  47. _ проявляет интерес и энтузиазм к занятиям в классе и, кажется, любит учиться.
  48. _ вежлив по отношению к одноклассникам и всем взрослым сотрудникам школы.
  49. _ решает проблемы и проявляет большую настойчивость.
  50. _ нравится, когда его бросают вызов, и он выиграет от _ .
  51. _ тщательно и полностью выполняет свою работу.
  52. Я ценю _ аккуратную работу, которая сделана аккуратно.
  53. _ необходимо притормозить, чтобы производить качественную / тщательно выполненную работу.
  54. _ испытывает трудности с организационными навыками в классе, и ему необходимо поддерживать порядок на своем столе, чтобы его день протекал более гладко.
  55. _ изо всех сил пытается найти необходимые бумаги / материалы, и ему было бы полезно использовать папку / скоросшиватель / поддерживать более аккуратный стол.
  56. _ очень организован и легко находит необходимые материалы.
  57. _ демонстрирует хорошие гражданские отношения в нашем классе.
  58. упорно трудился, чтобы повысить свою оценку в _ , и я ценю его / ее усилия.
  59. _ отличается твердой трудовой этикой и никогда не выполняет задания наполовину.
  60. _ многому научился в этом году и продемонстрировал особые улучшения.
  61. _ необходимо запоминать основные математические факты, чтобы легче решать сложные математические задачи.
  62. _ может извлечь выгоду из _ , чтобы полностью запомнить основные математические факты.
  63. Запоминание основных математических фактов сложения / умножения было бы очень полезно для _ .
  64. _ показывает особые сильные стороны в области социальных исследований / естественных наук и очень хорошо учился в этом триместре / году.
  65. Тесты по естествознанию / обществоведению были очень трудными для _ , и ему / ей было бы полезно увеличить время, затрачиваемое на изучение материала.
  66. _ , кажется, увлекается наукой / общественными науками и в этом году проделал отличную работу.
  67. _ необходимо внимательно слушать и следовать указаниям во время урока.
  68. _ уделяет внимание деталям в своих заданиях, и я ценю высокое качество его работы.
  69. _ очень ответственный и выполняет домашние задания вовремя.
  70. _ использует навыки мышления более высокого уровня для выполнения сложных заданий.
  71. _ является активным участником небольших групп, а также дискуссий в классе.
  72. _ действительно хочет учиться и при необходимости задает соответствующие вопросы.
  73. _ имеет хорошее чувство темы / основной идеи / персонажей / сюжета / умозаключений, что усиливает его / ее способность к чтению.
  74. _ читает плавно и с хорошим выражением.
  75. _ может использовать данные из графиков и диаграмм / успешно использовать компас / правильно преобразовывать измерения.
  76. В этом триместре я хотел бы работать на _ .
  77. _ эффективно использует стратегии чтения, такие как _ , что улучшает понимание прочитанного.
  78. _ имеет большой словарный запас, что добавляет ему / ей способности эффективно писать.
  79. _ показывает сильные знания в области _ .
  80. _ может делиться соответствующей и актуальной информацией, которая помогает в обсуждениях в классе.
  81. _ постоянно прилагает все усилия в _ , что приятно видеть.
  82. _ приходит в школу каждый день со счастливым настроением, готовым учиться.
  83. _ превзошла ожидания в области _ .
  84. _ работает независимо и может завершить работы по обогащению, когда он / она закончит с необходимыми заданиями.
  85. _ может сосредоточиться и оставаться на задаче в течение независимого рабочего времени.
  86. Мне понравилось чувство юмора _ в нашем классе.
  87. _ замечательный характер, и его / ее чувство юмора заставляет меня улыбаться.
  88. _ отличный классер _ , и он / она сделал наш класс лучше.
  89. _ конструктивно использует учебное время.
  90. _ — гибкий ученик и легко адаптируется к новым задачам.
  91. В этом триместре я хотел бы, чтобы _ сосредоточился на _ , чтобы _ .
  92. _ всегда разумно использует свое время.
  93. _ превращается в красиво выполненную работу.
  94. _ требует много повторений и практики, чтобы сохранить _ .
  95. _ любит поэзию / чтение / музыку / науку / искусство… и преуспевает в этом.
  96. _ — внимательный студент и хорошо работает во всех предметных областях.
  97. Я хотел бы обратить внимание на _ , чтобы на _ .
  98. _ — очень талантливый художник, и мне действительно нравится страсть, которую он вкладывает в свои работы.
  99. Мне действительно понравилось познакомиться с _ и пожелать ему / ей всего наилучшего в классе и за его пределами.
  100. Мне понравилось иметь _ в нашем классе в этом году, и я буду очень скучать по нему / ей, когда он / она перейдет в класс _ .
  101. _ — особенный студент, которого я никогда не забуду. Я буду скучать по нему / по ней в следующем году.

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

Нужна новая любимая маркерная ручка для табелей успеваемости? Это мой личный фаворит.Мне нравятся шариковые ручки, потому что они не протекают и бывают всех цветов радуги. *

Щелкните здесь, чтобы получить свой собственный набор!

Знаете ли вы, что у меня есть БЕСПЛАТНАЯ библиотека ресурсов, полная эксклюзивных ресурсов верхнего уровня, которые вы больше нигде не найдете?

Щелкните изображение ниже, чтобы получить ресурсы прямо сейчас!

Спасибо, что заглянули!

* Этот пост содержит партнерские ссылки Amazon.Если вы совершите покупку по одной из этих ссылок, The Teacher Next Door, LLC получит несколько центов за доллар. Эта комиссия напрямую поддерживает нас как малый бизнес и гарантирует, что мы сможем и дальше создавать высококачественный контент для учителей старших классов начальной школы, таких как вы! Как всегда, распространенные продукты проверены и проверены. Наслаждаться!

Хороши ли комментарии на ваших страницах для SEO?

В этом отношении комментарии не имеют внутренней ценности для поисковой оптимизации (SEO), кроме участия в разговоре с единомышленниками.

Но как насчет сайта, на котором размещены комментарии ? Получат ли они повышение SEO от всего этого дополнительного контента на своих сайтах?

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

Позвоните по телефону 888-601-5359 , чтобы поговорить со специалистом по стратегии об услугах SEO от WebFX, или продолжайте readinfg, чтобы узнать больше о том, как комментарии в блоге могут помочь в оптимизации вашего сайта.

Независимое исследование Clutch назвало

WebFX — лучшая SEO-компания в США.

Более 200 клиентов WebFX были опрошены Clutch, чтобы обсудить их опыт сотрудничества с нами.

Ознакомьтесь с другими обзорами сцепления

Как сделать так, чтобы комментарии в блоге способствовали SEO

Что касается Google и других поисковых систем, комментарии в вашем блоге являются дополнительным содержанием на странице.Это означает, что если ваш пост в блоге состоит из 1200 слов и у вас есть комментарии на 400 слов, ваш пост будет оцениваться как содержащий 1600 слов.

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

Но есть несколько предостережений.

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

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

Преимущества комментариев в блогах и SEO

Есть несколько неотъемлемых преимуществ у комментариев в блогах для повышения вашего SEO.

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

Итак, если вы написали блог под названием «Почему SEO — это хорошо», кто-то может прокомментировать: «Я согласен, SEO — это потрясающе!» С этим комментарием у вас есть шанс получить рейтинг по ключевому слову, которое вы иначе могли бы пропустить в своем сообщении.

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

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

Google видит, что сообщение в блоге довольно длинное, что является хорошим показателем качества. Затем Google также видит, что под ним тонны текста — может быть, даже больше, чем сам пост.

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

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

Как получить комментарии, оптимизированные для SEO

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

Ваш первый вариант — включить комментарии через собственную систему управления контентом (CMS), которую вы используете для своего блога.WordPress, Wix и большинство других поставщиков блогов имеют встроенные системы комментариев, которые позволяют вашим читателям рассказывать о ваших сообщениях в блогах.

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

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

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

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

Пора повысить уровень продаж

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

ЗА ПОСЛЕДНИЕ 5 ЛЕТ МЫ УПРАВЛИЛИ БОЛЕЕ 11,5 МИЛЛИОНАМИ ОПЕРАЦИЙ НА НАШЕЙ КЛИЕНТСКОЙ БАЗЕ.
Получите предложение!

WebFX — профессиональное блог-агентство

В WebFX есть целая команда контент-маркетологов, которые знают, как использовать блоги (и комментарии в блогах) на благо вашего сайта.

Добавить комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *