AppleScript для абсолютных новичков

Дата публикации:17.07.2012
Twitter Facebook Vkontakte

Глава 9. Нет комментариев? Недопустимо!

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

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

Чтобы создать комментарий, начните его с двух дефисов (минусов).

-- Это комментарий

После компиляции (проверки синтаксиса), комментарий показывается серым цветом.

-- И это комментарий
-- Этот комментарий занимает больше чем две строки

Иногда, многострочные комментарии заключаются между скобками (* *)

(* Этот комментарий
растянут на две строки.*)

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

Заключая часть вашего сценария между кавычками (* *), вы можете временно отключить ("закомментировать") часть сценария, чтобы посмотреть продолжит ли он работать так как положено. Это позволяет отлавливать ошибки. Если закомментированная часть сценария должна приводить к какому-то результату, например, к присваиванию значения некоторой переменной, включите временную строку, где устанавливается переменная на значение соответствующее для тестирования оставшегося сценария.

Контекстное меню редактора Script Editor позволяет легко что-нибудь закомментировать. Если вы хотите закомментировать часть вашего сценария, выделите эту часть, например протягиванием мыши. Затем щелкните с нажатым Control в верхнем поле и выберите "Comment Tags". Попробуйте добавить или удалить теги комментария в выбранном тексте. Первое выполнение процедуры "Comment Tags" заключит выделенный текст в теги комментария, при втором - в выделенном тексте они будут удалены. Если ваши пояснения были помещены после двух дефисов, то эта процедура их не затронет.

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

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

Дополнительная информация

  1. Полный вариант книги (rtf/7z)-- электронная книга с сохранением иллюстраций, форматирования, изменений в цвете шрифта.


Распространение материалов сайта означает, что распространитель принял условия лицензионного соглашения.
Идея и реализация: © Владимир Довыденков и Анатолий Камынин,  2004-2019