Главная страница Случайная страница
КАТЕГОРИИ:
АвтомобилиАстрономияБиологияГеографияДом и садДругие языкиДругоеИнформатикаИсторияКультураЛитератураЛогикаМатематикаМедицинаМеталлургияМеханикаОбразованиеОхрана трудаПедагогикаПолитикаПравоПсихологияРелигияРиторикаСоциологияСпортСтроительствоТехнологияТуризмФизикаФилософияФинансыХимияЧерчениеЭкологияЭкономикаЭлектроника
Уровень программы
|
|
Существуют комментарии и более низкого уровня — они включаются непосредственно в программу. Обычно они используются в тех случаях, когда некоторая строка кода требует особого внимания. Благодаря своему коллеге Скотту я начал использовать особую форму комментариев, которая упрощает процессы документирования и отладки (особенно в условиях рабочих групп). В следующей таблице приведены некоторые из этих комментариев.
| Обозначение | Описание |
| ' | Комментарий общего назначения. Используется для любых пометок, не требующих особого внимания |
| '??? | Спорный фрагмент программу. Особенно полезен при работе в составе группы, а также при отладке чужих программ. Обозначает код, который может оказаться спорным или избыточным, или же потребовать вашего внимания позднее |
| '!!! | Код требует особого внимания! Комментарий напоминает об этом программисту. Может использоваться для кода, который необходимо тщательно проверить, удалить или восстановить в прежнем виде |
Наиболее распространенная форма комментария — обычный апостроф. Каждый раз, когда апостроф встречается в тексте программы вне строковых констант, весь текст справа от него считается комментарием. Как вы вскоре убедитесь, это позволяет разработать достаточно гибкую и универсальную систему комментирования.
В простейшем случае апостроф является единственным символом в строке и помогает визуально разделить фрагменты программы или комментария. Такие «вырожденные» комментарии неоднократно встречаются в предыдущих примерах этого урока. Как показано в приведенной таблице, за апострофом могут следовать дополнительные символы, которые используются для нестандартных комментариев.
Комментарии второго и третьего типа (см. таблицу) можно легко расширить для работы в группах. Например, в них можно включить свои инициалы, чтобы при необходимости вы могли легко найти интересующий вас код. Если некоторый фрагмент должен быть исключен из окончательного варианта программы, его можно снабдить комментарием типа
'!!! " - СБ Удалить, если построение пройдет успешно.
Чтобы найти весь код, который необходимо удалить перед окончательной компиляцией, достаточно выполнить в проекте поиск строки!!! - СБ.
Хотя описанные приемы приносят несомненную пользу, они, конечно, не исчерпывают всех возможностей комментирования. Используйте ту методику, которая покажется вам наиболее удобной. Тем не менее, обязательно соблюдайте единый стиль комментирования — это сэкономит время отладки приложения!