Как-то раз сидел в аудитории с ноутом около розетки, а в это время на соседней парте принимался зачет по программированию. Я не сильно вникал в суть вопросов на которые общались студент и преподаватель, назовем его Иван Ивановичем. Разговор был довольно спокойный и тихий, но у меня получилось выхватить часть. Преподаватель говорил о комментариях (видимо сдавалась программа, в которой не было ни строчки комментариев). Меня этот момент заинтересовал и я начал прислушиваться. Было замечено, что мне тоже интересно, преподаватель начал импровизированную лекцию. Ниже представлен тот небольшой кусок знаний который я тогда вынес с этой 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! Вы на нее смотрите и пишите комментарий // Многа букаф! Ниасилил
После этого человек пришедший после вашего увольнения на ваше место видит этот комментарий и… все! Он даже не будет пытаться в нем разобраться и эта ваша запись будет клеймом на этом куске кода до тех пор пока его не уберут (либо код, либо комментарий).

Напоследок

В заключение могу сказать, что искусство написания комментариев является неотъемлемой частью искусства программирования, поэтому

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

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

Как написать хороший комментарий

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

Основные правила комментирования

Требования к комментариям выгладят таким образом:

1. Материал следует излагать с опорой на перечитанный текст.
2. В тексте должно быть отражено движение мысли автора.
3. Материал должен быть связан с авторской позицией.
4. В своем рассуждении следует выставить несколько примеров из исходника.

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

Примеры клише для написания комментария

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

• зачин;
• развитие;
• концовка или вывод.

На каком материале лучше поднимать проблему текстов

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

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

1. Какие примеры автор применяет для раскрытия проблемы? (Изучая вопрос дружбы, писателем освещаются отношения людей в современном обществе).
2. При помощи каких фактов или событий освещается проблема? (Автор концентрирует внимание на том факте, что в современном мире настоящую дружбу часто заменяют короткие, не несущие духовности отношения).
3. Какие мысли писателя стоят того, чтобы на них обратили особое внимание? (Он с горькой иронией описывает так званую дружбу игроков в преферанс, дружбу «сплетников», дружбу собутыльников. При этом он сравнивает людей с деревянными шарами, которые после столкновения опять остаются в одиночестве).

Виды комментариев

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

Как правильно выявлять проблему?

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

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

Ошибки комментирования

Как правило, при написании комментария допускают такие ошибки:

1. Он написан без опоры на текст.
2. Вместо комментария написан пересказ или просто использованы цитаты.
3. Он не относиться к рассматриваемой проблеме.

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

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

Читайте также:

Как правильно поступать

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

Вывод

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

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

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

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

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

Различают два типа комментария.

Внимание

В любом случае комментарий должен опираться на прочитанный текст!

Типы информации в тексте

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

Фактуальная информация - это сообщение о фактах, событиях, процессах, которые происходили, происходят или будут происходить в действительности.

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

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

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

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

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

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

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

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

Например:
Особенно мне запомнились строки из стихотворения С. А. Есенина: Гой ты, Русь, моя родная, Хаты - в ризах образа... Не видать конца и края - Только синь сосёт глаза.

При цитировании «в строчку» ставятся кавычки, а текст цитаты по-мещается на той же строке: В конце стихотворения Марины Цветаевой образ рябины становится символом родины, напоминанием о том, что родина является неотъемлемой частью каждого из нас, а за многоточием скрывается целая буря невысказанных чувств: «Но если по дороге - куст встаёт, особенно - рябина...».

Косвенная речь представляет собой сложноподчинённое предложение с придаточным изъяснительным. Она удобна тем, что не требует точной, дословной передачи исходного текста - достаточно сохранить общее со-держание. При замене прямой речи косвенной необходимо местоимения и глаголы в форме 1-го или 2-го лица заменить формами третьего лица.

При использовании вводных конструкций (по мнению автора, по словам Солоухина и т. п.) цитата начинается с маленькой буквы, а кавычки используются в том случае, если в высказывании нет форм 1-го лица. Например: По мысли С. Соловейчика, «успех в одной работе не проходит бесследно для другой». В любом случае не увлекайтесь цитированием! Помните, что каждая цитата должна быть уместной, т. е. служить иллюстрацией какой-либо вашей мысли.

Типичные ошибки при формулировании проблемы

Рассмотрим фрагменты из ученических сочинений, написанных по тексту Ю. Лотмана, с ошибками при комментировании проблемы.

Я - старый человек. Пережил солдатом большую войну, исходил пешком и Россию, и Европу. Среди моих близких друзей были и есть и армяне, и азербайджанцы, и грузины, и эстонцы, и немцы, и многие другие. И теперь, на пороге смерти, я вынужден наблюдать то клиническое безумие ненависти, которое охватывает целые пространства нашей земли. Я жалею тех из них, кто ослеплён ненавистью. Неужели же они не видят, что ими играют и что те, кто сейчас из-за кулис разжигает кровавый туман, завтра направят удар против них? То, что делают их руками, очень скоро сделают с ними чьими-нибудь третьими. А те, кто стоит за кулисами, выступят как миротворцы, когда сочтут, что обе стороны пролили достаточно крови.

Эпоха мелких конфликтов и частных столкновений кончилась. Мир един, и то, что происходит на одном конце, неизбежно отзывается на другом. Спрятаться не удастся никому. Колокол звонит по каждому из нас. (По Ю. Лотману)

Что проверяет эксперт?

1) насколько полно прокомментирована проблема (выделено ли всё, что важно для понимания данной проблемы);
2) насколько верно прокомментирована проблематика исходного текста (нет ли искажений информации текста, неточностей, противоречий);
3) нет ли фактических ошибок, связанных с пониманием исходного текста.

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