Что нужно писать в комментариях. Пишем комментарии правильно

Как-то раз сидел в аудитории с ноутом около розетки, а в это время на соседней парте принимался зачет по программированию. Я не сильно вникал в суть вопросов на которые общались студент и преподаватель, назовем его Иван Ивановичем. Разговор был довольно спокойный и тихий, но у меня получилось выхватить часть. Преподаватель говорил о комментариях (видимо сдавалась программа, в которой не было ни строчки комментариев). Меня этот момент заинтересовал и я начал прислушиваться. Было замечено, что мне тоже интересно, преподаватель начал импровизированную лекцию. Ниже представлен тот небольшой кусок знаний который я тогда вынес с этой 5ти минутной лекции.

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

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

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

По сути говоря, на той лекции принцип TDD (Test-driven development, разработка через тестирование) был перенесен на уровень ниже. Не помню как это звучало в оригинале, но по сути «Опиши комментариями структуру кода» . На примере (сильно утрированном, почему - ниже) кода программы, складывающей два числа, этот принцип будет выглядеть так:
int main() { // Принять от пользователя два числа // Завести переменную для результата сложения // Вернуть результат сложения return 0; }
И лишь когда готов каркас из комментариев, следует писать код который будет реализовывать то, что описано комментариями.
... int main() { double a,b; // Принять от пользователя два числа cin>>a; cin>>b; //Завести переменную для результата сложения double sum = a+b; // Вернуть результат сложения cout< Как упоминалось выше, данный принцип представляет собой модифицированный принцип, хорошо зарекомендовавшего себя TDD. Тут следует понимать, что отступление от комментариев, в отличии от отступления от логики тестов, не приведет к тяжелым последствиям, ну разве что придется комментарии переписывать

Теперь представим «чисто гипотетическую» ситуацию, когда уже имеется код в 200 000 строк, написанный гениальным программистом криворуким индусом и не содержит ни строчки комментария. Однако вам необходимо, мало того что убить этого программиста понять этот код, но и сопровождать его в дальнейшем. Вы даже разобрались в этом коде, и будучи приличным человеком, решили дополнить код комментариями для, так сказать, будущих поколений. Но возникает вопрос: как?

Как комментировать уже существующий код

Ответ на этот вопрос довольно прост: комментируем сущности от родителя к потомку: класс -> метод -> код внутри метода (если необходимо).

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

  • Совсем уж очевидные вещи. Комментарии вида // инициализируем счетчик бесят больше чем их отсутствие
  • Непонятный код дополнять комментарием типа // ничего не понял
Относительно второго пункта стоит немного пояснить и привести пример: вставка 100 строк ассемблера код на C! Вы на нее смотрите и пишите комментарий // Многа букаф! Ниасилил
После этого человек пришедший после вашего увольнения на ваше место видит этот комментарий и… все! Он даже не будет пытаться в нем разобраться и эта ваша запись будет клеймом на этом куске кода до тех пор пока его не уберут (либо код, либо комментарий).
Напоследок
В заключение могу сказать, что искусство написания комментариев является неотъемлемой частью искусства программирования, поэтому

Другому человеку, и узнаем, что такое оповещения о комментариях.

В социальных сетях всегда есть возможность комментирования материалов – фотографий, видеозаписей и новостей на стене пользователя или сообщества. Так происходит общение и обмен информацией. Ниже мы посмотрим, как ВКонтакте работает эта операция.

Как ответить на комментарий в ВК

Выбираем в обсуждениях новости, фотографии или реплику и нажимаем “Ответить”

Далее вводим в текстовое поле ответ. К нему можно прикрепить вложение – фото, видео, аудио или . Также внизу окна отображается, кому вы отвечаете на комментарий. После того, как сообщение написано, нажимаем “Отправить”. Теперь в обсуждениях будет видно, кому именно вы адресовали ответ.

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

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

Оповещение об ответе на ваш комментарий

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

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

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

Иногда задают вопрос – можно ли ответить одним комментарием нескольким людям сразу. Пока ВКонтакте такой возможности нет. Если вы, написав один ответ, выберете еще одного пользователя, то у вас просто сменится “адресат” сообщения. На данный момент единственный выход – ответить по очереди всем комментаторам. Так будет проще и понятнее всем 🙂

А вы, когда-нибудь задумывались о том, что текст комментариев под видео на Ютубе может быть «нарядным», и привлекать к себе внимание множества зрителей.

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

А можно ли как-то выделиться среди общей массы комментариев ? Как оставить правильный комментарий на Ютубе?

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

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

Для выделения текста в комментариях используйте:

1. Жирным шрифтом используем звездочку («*»),

*Жирный текст*

2. Курсивом используем нижнее подчеркивание («_»)

_Курсив_

3. Зачеркнутый используем тире («-»)

Зачеркнутый текст-

После Нажатия кнопки «ОК» в окне комментариев отразится указанный тип шрифта.

Символы для комментариев.

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

к нему внимание. Для этого можно использовать специальные символы.

Таблицы спецсимволов легко можно найти в любом поисковике. Приведу здесь

несколько самых популярных значков.

☀ ☁ ☂ ☃ ☼ ☽ ★ ☆ ♘ ♙ ♙ ♚ ▲ △ ▼ ✹ ✺ ✻☎ ✿

А еще можно писать комментарии в Ютубе перевернутым шрифтом. Согласитесь, выглядит весьма необычно:-)

ǝqnʇnoʎ ɐн ииdɐɯнǝwwоʞ ǝıqɯʎdʞ qɯɐɔиu oıǝwʎ qdǝuǝɯ ʁ

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

значки подходят для Ютуба. Экспериментируйте и находите свой стиль. Продвижение с помощью комментариев. А в заключение еще два маленьких секрета Ютуб.

1. Вы можете очень быстро продвигать свои каналы YouTube в помощь могу предложить . Если будете знать как сделать грамотный комментарий под видео. В этом случае другие зрители будут

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

Хотите подробностей? Смотрите видео, где я рассказываю об этой секретной фишке.

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

только. Еще они позволяют показывать ваши видео на 1-ой позиции поиска YouTube. Представляете, один маленький символ хэштега «#», а делает настоящие чудеса!

Хотите подробностей? Примите участие в практическом интенсиве « » .
И получите от меня ВСЕ живые секреты Ютуб.

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

  • Тезис представляет собой ваше утверждение или точку зрения. Именно здесь вам нужно высказать свою точку зрения, а в оставшейся части комментария привести убедительные доводы.
  • Например, вам необходимо написать комментарий к роману Большие надежды . В этом случае можно предложить такой тезис: “Роман Диккенса представляет собой не только увлекательнейшую историю, но и наглядно демонстрирует различия между социальными классами в Великобритании в эру промышленной революции”.

Составьте план. Суть плана в значительной мере зависит от объема вашего комментария. План к краткому комментарию в виде маркированного списка или одного абзаца может включать базовую информацию. Для более объемного комментария следует обдумать последовательную и логичную структуру ответа.

  • Например, напишите заголовок “Ключевые темы книги” и укажите пункты маркированного списка, например “Место действия”, “Амбиции”, “Классы”.
  • Представьте выбранную тему. Вводный абзац позволит вам сосредоточиться на важных аспектах комментария. Например, во введении можно предоставить контекст литературного произведения и свой тезис, а затем провести анализ достоинств, недостатков, тем, других аспектов. В завершение сформулируйте краткий вывод о важности данной темы.

    • Например, начните так: “Описания в романе Большие надежды позволяют читателю ощущать, будто он находится в Англии 19 века вместе с главным героем по имени Пип. Вопросы классового неравенства, амбиций и любви в произведение Диккенса помогают разобраться в важных аспектах социального деления общества того времени”.
    • Далее можно перечислить список тем, которые будут рассмотрены в основной части текста.
  • Подкрепляйте тезис конкретными примерами. Заявите о теме, укажите соответствующее место произведения и поясните последствия или влияние данной темы или проблемы на произведение. Например, можно посчитать, что одержимость мисс Хэвишем идеей утраченной любви является важной темой романа Большие надежды .

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

    • Например, напишите: “Мисс Хэвишем - наглядный пример того, что любовь не всегда способна дарить радость и счастье. Этот аспект также следует учитывать при изучении отношений Эстеллы и Пипа”.
    • Используйте плавные переходы. Перед новым примером используйте подходящую фразу либо слово. Примеры: “аналогичным образом”, “с другой стороны”, “опять же”.
  • Напишите убедительный вывод. Заключительная часть должна связать вместе весь комментарий к произведению. Не забудьте подытожить все доводы. Также укажите, почему важно ознакомиться с данной книгой.

    Копылова Татьяна Олеговна,
    учитель русского языка и литературы
    ГБОУ гимназии №209
    Центрального района Санкт-Петербурга
    «Павловская гимназия»

    Что такое «комментарий к проблеме»?

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

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

    Объем комментария небольшой: трех - четырех развернутых фраз будет достаточно.

    Самое сложное - комментарий. Здесь не пройдут ни пересказ, ни сплошное цитирование. Проще всего поразмышлять над некоторыми вопросами, связанными с прочитанным текстом:

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

    · Можно оценить степень актуальности поднимаемой проблемы и объяснить, в чем ее актуальность?

    · Как автор текста подходит к решению этой проблемы? На каком жизненном/литературном материале строится текст? Типична ли ситуация, изображенная автором? На какие факты, детали автор обращает внимание? Почему? Какое это производит впечатление на читателя?

    · Если есть слова в необычном словоупотреблении (метафоры, эпитеты), которые остановили ваше внимание, и вы понимаете, что именно благодаря их выбору автору удалось донести до читателя свою мысль, неплохо обратить на них внимание.

    Требования к комментарию:

    1. Комментарий должен быть написан с опорой на прочитанный текст .

    2. Комментарий должен отражать ход мыслей автора исходного текста.

    3. Комментарий должен связывать сформулированную проблему с авторской позицией .

    4. В комментарии должно быть 2 (два) примера из предложенного текста .

    Чего нельзя делать при написании комментария?

    1. Нельзя комментировать проблему без опоры на прочитанный текст .

    2. Нельзя пересказывать прочитанный текст.

    3. Нельзя цитировать большие фрагменты из прочитанного текста.

    1. Собственный жизненный опыт, наблюдения

    2. Исторические факты

    3. Афоризмы, пословицы, поговорки

    5. Статистические данные

    6. Литературные источники и т.п.

    Комментарий выстраивается по определённой схеме:

    Композиция комментария

    Примеры типовых конструкций (клише)

    1. Зачин

    2. Развитие

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

    3. Вывод (концовка)

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

    Вариант 1 (по тексту публицистического стиля)

    Вопросы

    Образец рассуждения

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

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

    4.В чём значимость этих высказываний? (В чём убеждает нас автор?)

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

    Вариант 2 (по тексту художественного стиля)

    Вопросы

    Образец рассуждения

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

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

    3. Какие чувства героев описаны автором и каким образом?

    4.Какие слова (мысли) героев имеют особое значение?

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

    Можно выделить два типа комментария проблемы: текстуальный и концептуальный (концепционный).

    Тeкстуaльный кoммeнтaрий прeдстaвляeт сoбoй oбъяснeниe тeкстa, слeдoвaниe зa aвтoрoм в рaскрытии прoблeмы.

    Кoнкрeтизирoвaть сoдeржaниe кoммeнтaрия мoжнo с пoмoщью слeдующиx вoпрoсoв:

    1) Кaк, нa кaкoм мaтeриaлe aвтoр рaскрывaeт прoблeму?

    2) Нa чeм зaoстряeт внимaниe? Пoчeму?

    3) Кaкиe имeнa (фaкты, сoбытия) упoминaeт aвтoр? Для чeгo?

    4) Кaкиe эмoции aвтoрa вырaжeны в тeкстe?

    5) Кaк вырaжeнo oтнoшeниe aвтoрa к изoбрaжaeмoму? В чeм этo прoявляeтся?

    6) Кaкиe срeдствa вырaзитeльнoсти пoмoгaют выявить aвтoрскoe oтнoшeниe к прoблeмe?

    2. При кoнцeпциoннoм кoммeнтaрии в цeнтрe внимaния интeрпрeтaция прoблeмы тeкстa, ee aктуaльнoсть, стoлкнoвeниe рaзличныx мнeний пoдaннoму вoпрoсу и т.п. Нaйди oтвeты нa слeдующиe вoпрoсы:

    1) К кaкoму типу принaдлeжит этa прoблeмa? (Сoциaльнaя, филoсoфскaя, экoлoгичeскaя, нрaвствeннaя и т.п.)

    2) Aктуaльнa ли этa прoблeмa в нaши дни? В чeм ee знaчимoсть для oбщeствa?

    3) Кaк чaстo мы стaлкивaeмся с этoй прoблeмoй? Кaсaeтся ли oнa кaждoгo из нaс или тoлькo людeй oпрeдeлeннoгo вoзрaстa, рoдa зaнятий и т.п.?

    Типовые конструкции (клише) для комментирования проблемы

    Текстовый комментарий (художественный текст)

    Текстовый комментарий (публицистический текст)

    Концептуальный комментарий (публицистический текст)

    Не случайно писатель изображает (кого, что)…

    Поступок героя свидетельствует о том, что …

    Слова (мысли) героя показывают, что …

    Проблема (чего?) - одна из актуальных проблем нашего времени.

    Данная социальная (нравственная и т.п.) проблема имеет многовековую историю.

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

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

    Введение цитат в текст сочинения.

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

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

    Используемые материалы:

    Н.А.Сенина, А.Г.Нарушевич «Русский язык. Сочинение на ЕГЭ. Курс интенсивной подготовки» Легион, 2012