Dreammmless.
Эксперт
-
Автор темы
- #1
Предыдущая тема от gddcfd - https://yougame.biz/threads/152684/
Оригинальная статья -
ЮГЕЙМ ЖАЛУЕТСЯ НА КОЛ-ВО BB КОДОВ, ТАК ЧТО НЕКОТОРЫЕ (большенство) ИЗ НИХ БУДУТ СКРИНАМИ :(
Комментарий - это читаемая программистом заметка, которая вставляется непосредственно в исходный код программы. Комментарии игнорируются компилятором и предназначены только для использования программистом.
В C++ есть два различных стиля комментариев, оба из которых служат одной и той же цели: помочь программистам каким-то образом документировать код.
Однострочные комментарии
Символ // начинает однострочный комментарий C++, который говорит компилятору игнорировать все, начиная с символа // и заканчивая концом строки. Например:
Как правило, однострочный комментарий используется для быстрого комментария к одной строке кода.
Наличие комментариев справа от строки может затруднить чтение как кода, так и комментария, особенно если строка длинная. Если строки довольно короткие, комментарии можно просто выровнять (обычно до остановки табуляции), например:
Однако, если строки длинные, размещение комментариев справа может сделать ваши строки действительно очень длинными. В этом случае однострочные комментарии часто помещаются над строкой, которую он комментирует
Многострочные комментарии
Пара символов /* и */ обозначает многострочный комментарий в стиле С. Все, что находится между символами, игнорируется.
Поскольку все, что находится между символами, игнорируется, вы иногда увидите, как программисты "украшают” свои многострочные комментарии:
Многострочные комментарии стиля не могут быть вложенными. Следовательно, следующее будет иметь неожиданные результаты:
Когда компилятор пытается скомпилировать это, он игнорирует все, начиная с первого /* и заканчивая первым */. Поскольку “это не внутри комментария */" не считается частью комментария, компилятор попытается скомпилировать его. Это неизбежно приведет к ошибке компиляции.
Это одно из мест, где использование синтаксического маркера может быть действительно полезно, Так как различная окраска комментария должна прояснить, что считается частью комментария, а что нет.
Как правило, комментарии следует использовать для трех вещей. Во-первых, для данной библиотеки, программы или функции комментарии лучше всего использовать для описания того, что делает библиотека, программа или функция. Они обычно размещаются в верхней части файла или библиотеки или непосредственно перед функцией. Например:
Все эти комментарии дают читателю хорошее представление о том, что библиотека, программа или функция пытаются выполнить, не глядя на фактический код. Пользователь (возможно, кто-то другой или вы, если вы пытаетесь повторно использовать ранее написанный код) может с первого взгляда определить, имеет ли этот код отношение к тому, что он или она пытается выполнить. Это особенно важно при работе в составе команды, где не все будут знакомы со всем кодом.
Во-вторых, в библиотеке, программе или функции, описанной выше, комментарии могут использоваться для описания того, как код собирается достичь своей цели.
Эти комментарии дают пользователю представление о том, как код собирается достичь своей цели, не понимая, что делает каждая отдельная строка кода.
В-третьих, на уровне оператора комментарии должны использоваться для описания того, почему код что-то делает. Плохой комментарий к утверждению объясняет, что делает код. Если вы когда-нибудь пишете код, который настолько сложен, что нуждается в комментарии, чтобы объяснить, что делает оператор, вам, вероятно, нужно переписать свой оператор, а не комментировать его.
Вот несколько примеров плохих комментариев к строкам и хороших комментариев к утверждениям.
Плохой комментарий:
Причина: мы уже можем видеть, что зрение устанавливается на 0, глядя на утверждение
Хороший комментарий:
Причина: теперь мы знаем, почему зрение игрока устанавливается на 0
Плохой комментарий:
Причина: мы видим, что это расчет стоимости, но почему количество умножается на 2?
Хороший комментарий:
Причина: теперь мы знаем, почему эта формула имеет смысл.
Программистам часто приходится принимать трудное решение между решением проблемы одним способом или решением ее другим способом. Комментарии - отличный способ напомнить себе (или рассказать кому-то еще) о причине, по которой вы приняли одно решение вместо другого.
Хороший комментарий:
Наконец, комментарии должны быть написаны таким образом, чтобы это имело смысл для тех, кто понятия не имеет, что делает код. Часто бывает так, что программист скажет: "это очевидно, что это делает! Я ни за что не забуду об этом”. Знаешь что? Это не очевидно, и вы будете поражены, как быстро вы забудете. :) Позже вы (или кто-то другой) поблагодарите вас за то, что вы записали "что", " как " и "почему" вашего кода на человеческом языке. Читать отдельные строки кода очень легко. Понимание того, какую цель они призваны достичь, - нет.
Комментирование кода
Преобразование одной или нескольких строк кода в комментарий называется комментированием кода. Это обеспечивает удобный способ (временно) исключить части вашего кода из включения в скомпилированную программу.
Чтобы закомментировать одну строку кода, просто используйте комментарий стиля //, чтобы временно превратить строку кода в комментарий:
Не закомментировано:
Закомментировано:
Чтобы закомментировать блок кода, используйте // на нескольких строках кода или комментарий стиля /**/, чтобы временно превратить блок кода в комментарий.
Не закомментировано:
Закомментировано:
или
Есть довольно много причин, по которым вы можете захотеть сделать это:
1) Вы работаете над новым фрагментом кода, который еще не компилируется, и вам нужно запустить программу. Компилятор не позволит вам скомпилировать код, если есть ошибки компилятора. Комментирование кода, который не будет компилироваться, позволит программе компилироваться, чтобы вы могли ее запустить. Когда вы будете готовы, вы можете раскомментировать код и продолжить работу над ним.
2) Вы написали новый код, который компилируется, но работает неправильно, и у вас нет времени, чтобы исправить его позже. Комментирование сломанного кода гарантирует, что сломанный код не будет выполняться и вызывать проблемы, пока вы не сможете его исправить.
3) Найти источник ошибки. Если программа не дает желаемых результатов (или дает сбой), иногда бывает полезно отключить некоторые части кода, чтобы проверить, можно ли изолировать то, что вызывает ее неправильную работу. Если вы закомментируете одну или несколько строк кода, и ваша программа начнет работать так, как ожидалось (или прекратит сбой), скорее всего, то, что вы в последний раз закомментировали, было частью проблемы. Затем вы можете исследовать, почему эти строки кода вызывают проблему.
4) Вы хотите заменить один фрагмент кода другим фрагментом кода. Вместо того чтобы просто удалить исходный код, вы можете закомментировать его и оставить там для справки, пока не убедитесь, что ваш новый код работает правильно. Как только вы убедитесь, что ваш новый код работает, вы можете удалить старый закомментированный код. Если вы не можете заставить ваш новый код работать, вы всегда можете удалить новый код и раскомментировать старый код, чтобы вернуться к тому, что у вас было раньше.
Комментирование кода-это обычная вещь, которую нужно делать во время разработки, поэтому многие IDE предоставляют поддержку для комментирования выделенного раздела кода. Способ доступа к этой функциональности зависит от среды IDE.
Вообщем,
Спасибо за прочтение :).
Оригинальная статья -
Пожалуйста, авторизуйтесь для просмотра ссылки.
ЮГЕЙМ ЖАЛУЕТСЯ НА КОЛ-ВО BB КОДОВ, ТАК ЧТО НЕКОТОРЫЕ (большенство) ИЗ НИХ БУДУТ СКРИНАМИ :(
Комментарий - это читаемая программистом заметка, которая вставляется непосредственно в исходный код программы. Комментарии игнорируются компилятором и предназначены только для использования программистом.
В C++ есть два различных стиля комментариев, оба из которых служат одной и той же цели: помочь программистам каким-то образом документировать код.
Однострочные комментарии
Символ // начинает однострочный комментарий C++, который говорит компилятору игнорировать все, начиная с символа // и заканчивая концом строки. Например:
Как правило, однострочный комментарий используется для быстрого комментария к одной строке кода.
Наличие комментариев справа от строки может затруднить чтение как кода, так и комментария, особенно если строка длинная. Если строки довольно короткие, комментарии можно просто выровнять (обычно до остановки табуляции), например:
Однако, если строки длинные, размещение комментариев справа может сделать ваши строки действительно очень длинными. В этом случае однострочные комментарии часто помещаются над строкой, которую он комментирует
Приведенные выше утверждения представляют собой одну из наших первых встреч с фрагментами кода. Поскольку сниппеты не являются полноценными программами, они не могут быть скомпилированы сами по себе. Скорее, они существуют для того, чтобы продемонстрировать конкретные концепции в сжатой форме.
Если вы хотите скомпилировать фрагмент, вам нужно будет превратить его в полную программу, чтобы он компилировался. Как правило, эта программа будет выглядеть примерно так:
Если вы хотите скомпилировать фрагмент, вам нужно будет превратить его в полную программу, чтобы он компилировался. Как правило, эта программа будет выглядеть примерно так:
Многострочные комментарии
Пара символов /* и */ обозначает многострочный комментарий в стиле С. Все, что находится между символами, игнорируется.
Поскольку все, что находится между символами, игнорируется, вы иногда увидите, как программисты "украшают” свои многострочные комментарии:
Многострочные комментарии стиля не могут быть вложенными. Следовательно, следующее будет иметь неожиданные результаты:
C++:
/* Это многострочный /* комментарий */ это не внутри комментария */
// Приведенный выше комментарий заканчивается на первом */, не на втором */Это одно из мест, где использование синтаксического маркера может быть действительно полезно, Так как различная окраска комментария должна прояснить, что считается частью комментария, а что нет.
Правильное использование комментариев
Как правило, комментарии следует использовать для трех вещей. Во-первых, для данной библиотеки, программы или функции комментарии лучше всего использовать для описания того, что делает библиотека, программа или функция. Они обычно размещаются в верхней части файла или библиотеки или непосредственно перед функцией. Например:
C++:
// Эта программа вычисляет итоговую оценку студента на основе его тестов и домашних заданий.
// Эта функция использует метод Ньютона для аппроксимации корня данного уравнения.
// Следующие строки генерируют случайный элемент на основе редкости, уровня и весового коэффициента.Во-вторых, в библиотеке, программе или функции, описанной выше, комментарии могут использоваться для описания того, как код собирается достичь своей цели.
C++:
/* Чтобы рассчитать итоговую оценку, мы суммируем все взвешенные промежуточные и домашние баллы,
а затем разделить на количество баллов, чтобы присвоить процент, который равен
используется для расчета буквенной оценки. */
C++:
// Чтобы сгенерировать случайный элемент, мы сделаем следующее:
// 1) Поместите все предметы желаемой редкости в список
// 2) Вычислить вероятность для каждого элемента на основе уровня и весового коэффициента
// 3) Выберите случайное число
// 4) Выясните, какому элементу соответствует это случайное число
// 5) Вернуть соответствующий товарВ-третьих, на уровне оператора комментарии должны использоваться для описания того, почему код что-то делает. Плохой комментарий к утверждению объясняет, что делает код. Если вы когда-нибудь пишете код, который настолько сложен, что нуждается в комментарии, чтобы объяснить, что делает оператор, вам, вероятно, нужно переписать свой оператор, а не комментировать его.
Вот несколько примеров плохих комментариев к строкам и хороших комментариев к утверждениям.
Плохой комментарий:
C++:
// Устанавливаем диапазон sight на 0
зрение = 0;Хороший комментарий:
C++:
// Игрок просто выпил зелье слепоты и ничего не видит
зрение = 0;Плохой комментарий:
C++:
// Рассчитать стоимость товаров
стоимость = количество * 2 * цена_в_магазине;Хороший комментарий:
C++:
// Здесь нам нужно умножить количество на 2, потому что они покупаются парами
стоимость = количество * 2 * цена_в_магазине;Программистам часто приходится принимать трудное решение между решением проблемы одним способом или решением ее другим способом. Комментарии - отличный способ напомнить себе (или рассказать кому-то еще) о причине, по которой вы приняли одно решение вместо другого.
Хороший комментарий:
C++:
// Мы решили использовать связанный список вместо массива, потому что
// массивы делают вставку слишком медленно.
// Мы собираемся использовать метод Ньютона, чтобы найти корень числа, потому что
// нет никакого детерминированного способа решить эти уравнения.На протяжении всей остальной части этой серии уроков мы будем использовать комментарии внутри блоков кода, чтобы привлечь ваше внимание к конкретным вещам или помочь проиллюстрировать, как они работают (гарантируя, что программы все еще компилируются). Проницательные читатели заметят, что по вышеприведенным стандартам большинство этих комментариев ужасны. :) Когда вы читаете остальные учебники, имейте в виду, что комментарии служат намеренной образовательной цели, а не пытаются продемонстрировать, как выглядят хорошие комментарии.
Комментирование кода
Преобразование одной или нескольких строк кода в комментарий называется комментированием кода. Это обеспечивает удобный способ (временно) исключить части вашего кода из включения в скомпилированную программу.
Чтобы закомментировать одну строку кода, просто используйте комментарий стиля //, чтобы временно превратить строку кода в комментарий:
Не закомментировано:
Закомментировано:
Чтобы закомментировать блок кода, используйте // на нескольких строках кода или комментарий стиля /**/, чтобы временно превратить блок кода в комментарий.
Не закомментировано:
Закомментировано:
или
Есть довольно много причин, по которым вы можете захотеть сделать это:
1) Вы работаете над новым фрагментом кода, который еще не компилируется, и вам нужно запустить программу. Компилятор не позволит вам скомпилировать код, если есть ошибки компилятора. Комментирование кода, который не будет компилироваться, позволит программе компилироваться, чтобы вы могли ее запустить. Когда вы будете готовы, вы можете раскомментировать код и продолжить работу над ним.
2) Вы написали новый код, который компилируется, но работает неправильно, и у вас нет времени, чтобы исправить его позже. Комментирование сломанного кода гарантирует, что сломанный код не будет выполняться и вызывать проблемы, пока вы не сможете его исправить.
3) Найти источник ошибки. Если программа не дает желаемых результатов (или дает сбой), иногда бывает полезно отключить некоторые части кода, чтобы проверить, можно ли изолировать то, что вызывает ее неправильную работу. Если вы закомментируете одну или несколько строк кода, и ваша программа начнет работать так, как ожидалось (или прекратит сбой), скорее всего, то, что вы в последний раз закомментировали, было частью проблемы. Затем вы можете исследовать, почему эти строки кода вызывают проблему.
4) Вы хотите заменить один фрагмент кода другим фрагментом кода. Вместо того чтобы просто удалить исходный код, вы можете закомментировать его и оставить там для справки, пока не убедитесь, что ваш новый код работает правильно. Как только вы убедитесь, что ваш новый код работает, вы можете удалить старый закомментированный код. Если вы не можете заставить ваш новый код работать, вы всегда можете удалить новый код и раскомментировать старый код, чтобы вернуться к тому, что у вас было раньше.
Комментирование кода-это обычная вещь, которую нужно делать во время разработки, поэтому многие IDE предоставляют поддержку для комментирования выделенного раздела кода. Способ доступа к этой функциональности зависит от среды IDE.
Вы можете прокомментировать или раскомментировать выборку с помощью меню Правка > дополнительно > выбор комментария (или выбор Раскомментирования ( Edit menu > Advanced > Comment Selection / Uncomment Selection)).
Вы можете прокомментировать или раскомментировать выделение с помощью меню Правка > комментарий (или раскомментировать, или переключить комментарий, или любой из других инструментов комментариев).
Если вы всегда используете однострочные комментарии для своих обычных комментариев, то вы всегда можете использовать многострочные комментарии, чтобы закомментировать свой код без конфликта. Если вы используете многострочные комментарии для документирования кода, то комментирование кода с помощью комментариев может стать более сложным делом.
Если вам действительно нужно закомментировать блок кода, содержащий многострочные комментарии, вы также можете рассмотреть возможность использования директивы препроцессора #if 0, которую мы обсудим в уроке 2.10 - введение в препроцессор.
Если вам действительно нужно закомментировать блок кода, содержащий многострочные комментарии, вы также можете рассмотреть возможность использования директивы препроцессора #if 0, которую мы обсудим в уроке 2.10 - введение в препроцессор.
Вообщем,
- На уровне библиотеки, программы или функции используйте комментарии, чтобы описать, что именно.
- Внутри библиотеки, программы или функции используйте комментарии, чтобы описать, как это сделать.
- На уровне утверждения используйте комментарии, чтобы описать, почему.
Спасибо за прочтение :).