Комментарии в программе на языке delphi бывают. пример объявления глобальных переменных. Сгенерированный оболочкой Delphi шаблон

Второй способ, как и многое в Delphi, не совсем очевиден — мы используем поставляемую вместе с IDE утилиту XMLDoc . Её можно найти в папке Мои документы\RAD Studio\ <версия Delphi>\Demos\XMLDoc . Кроме того, вам потребуется установить Java SDK (1.4.2 или выше), Python (минимум 2.3) и (версия 6.5.5 for Java). После установки нужно будет добавить в системную переменную “Path ” пути куда установлены Python и Saxon, например “C:\Python23\;C\Saxon655\” (это делается через «Мой компьютер», а в нём — «Переменные среды», пути нужно добавить через точку с запятой). В папке, куда вы распаковали Saxon, создайте BAT файл с именем saxon.bat с таким содержанием:

@java -jar "<путь к папке с Saxon>\saxon.jar" %1 %2 %3

Запускать его не нужно. В папке с XMLDoc-ом создайте BAT файл start.bat , чтобы не морочиться с командной строкой, и напишите в нём следующее:

Cls xmldoc.py "<путь к папке с проектом>" pause

Пример пути — “C:\Projects\TestProject”. Важно: все используемые пути не должны содержать кириллицу, иначе у XMLDoc-а с ней будут проблемы. Итак, теперь всё готово, и можно запускать файл start.bat. Если всё пройдет успешно, то в папке с проектом появится папка doc , а в ней — final, в которой будут храниться HTML файлы сгенерированной документации. Вот что у меня получилось (на примере метода OpenTables):

По субъективной оценке данный вариант выглядит посимпатичнее первого. Вроде бы все замечательно, но усугубляет тот факт, что XMLDoc так же небрежно вырезал ссылку . Нужно заметить что эти HTML файлы не окончательный вариант — их можно (и, по идее, нужно) преобразовать в формат Help 2.0 (их затем можно будет просматривать через Document Explorer , так же, как и хэлп в Delphi или Visual Studio). Для этого понадобится Visual Studio Help Integration Kit , а затем — CodeGear HelpKit . Так как у меня нервов больше не хватило, а результат уже в принципе понятен, я не стал идти дальше. Возвожно, вы окажетесь сильнее:)

Генерация документации с использованием Doc-O-Matic Express

Doc-O-Matic — довольно мощная утилита для создания документации на основе XML и JavaDoc комментариев в форматах HTML, CHM и Help 2.0. Но, к сожалению, полная её версия платная. Но не всё так плохо — есть версия Express (наверное подсмотрели название у Microsoft), а в ней есть почти всё что нужно. Её и опробуем.

С Doc-O-Matic не придется так много плясать с бубном, как с XMLDoc, но парой кликов тоже не обойдешься. Запустите утилиту, в разделе Project Files нажмите кнопку Add , в фильтре диалога выберите Delphi 2007 Project и откройте нужный файл проекта. Во вкладке HTML обратите внимание на раздел Files & Folders — в нём можно указать папку, куда будет помещён файл с документацией. Сохраните настройки в какое-нибудь удобоваримое место, намример в файл C:\mydoc.dox-express. Теперь закройте утилиту и зайдите в папку, куда установлен Doc-O-Matic. Создайте в ней BAT файл с такой строчкой:

Domexpress.exe -config "HTML" "<путь к файлу *.dox-express>"

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

Опять же, субъективно, такой хэлп производит наиболее благоприятное впечатление. Нет лишних пунктов, удобная навигация. Немного портит впечатление отсутствие ссылки на слове “TMainForm”, но Doc-O-Matic хотя бы её не вырезал, в отличие от двух предыдущих утилит.

Вместо послесловия. Поддержка XML комментариев на уровне редактора кода в Delphi — отличная и удобная штука, и ей надо пользоваться. Но с генерацией документации дело обстоит сложнее: стандартные средства слишком сырые (и, чего душой кривить, кривые =), чтобы ими можно было без труда пользоваться. Но есть альтернатива в лице Doc-O-Matic Express, который справляется с этим делом весьма неплохо. Будем надеятся, что в скором времени (может быть и с выходом новых версий Delphi) появятся и новые, более гибкие утилиты.

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

Комментарии могут оформляться двумя способами:

1. все, что идет после двойного слеша // , воспринимается как комментарий
   (так можно оформить только одну строку комментария);
2. все, что заключено в фигурные скобки { и }, тоже является комментарием
   (в этом случае можно включить в комментарий сколько угодно строк).

Пример комментария

Это уже не комментарий

{ Это снова комментарий
И это тоже }

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

Теперь вы готовы к изучению языка программирования Delphi. Создайте новый проект. После этого перейдите в редактор кода. Здесь для вас уже написана заготовка будущей программы.

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

Сгенерированный оболочкой Delphi шаблон

interface

uses //После этого слова идет перечисление подключенных модулей.
Windows, Messages, SysUtils, Variants, Classes, Graphics, Controls, Forms,
Dialogs;

type //После этого идет объявление типов
TForml = class (TForm) //Начало описания нового объекта TForm. Здесь описываются компоненты и события Формы
private //После этого слова можно описывать закрытые данные объекта
{ Private declarations }
доступные только для объекта TForml
public //После этого слова можно описывать открытые данные объекта
{ Public declarations } //Подсказка, которую сгенерировал Delphi. Здесь можно описывать переменные и методы,
доступные из любого другого модуля
end ; //Конец объявления типов

var //Объявление глобальных переменных
Forml: TForml; //Это описана переменная Forml типа объекта TForml

implementation

{$R *.dfm} //Подключение.dfm файла (файл с данными о визуальных объектах)

end . // end с точкой - конец модуля

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

Практически все строчки заканчиваются знаком "; " (точка с запятой). Этот знак показывает конец оператора. Он ставится только после операторов и никогда не используется после ключевых слов типа

uses, type, begin, implementation, private, public

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

Итак, разберем структуру кода. В самом начале стоит имя модуля. Оно может быть любым, но таким же, как и имя файла (без учета его расширения). Изменять имя модуля вручную нежелательно. Если все же надо изменить, то сохраните сначала модуль со старым именем. Для этого нужно выбрать команду меню: File | Save As (Файл | Сохранить как).

Желательно давать модулям понятные имена. В этом случае по имени можно определить, что находится внутри одноименного модуля. Трудно догадаться, что находится в файле под именем Unitl.pas. Файлам также желательно давать такие имена, которые связаны с их содержимым. Например, главную форму программы лучше сохранять в файле с именем MainUnit.pas или MainModule.pas. В этом случае модуль и файл будут иметь имя MainUnit или MainModule, и вы можете сразу определить, что это главная форма.

Далее идет подключение глобальных модулей. Все процедуры, функции, константы описаны в каком-нибудь модуле, и прежде чем эти процедуры использовать, нужно его подключить. Вы можете знать о существовании какой-нибудь функции. Но чтобы об этом узнал компилятор, вы должны указать модуль, где описана эта функция, понятным для компилятора языком. Например, вам надо превратить число в строку. Для этого в Delphi уже есть функция IntTostr. Она описана в модуле Sysutils. Если вы хотите воспользоваться этой функцией, вам надо подключить этот модуль к своему модулю Формы (напечатать название Sysutils в разделе uses).

Существуют четыре типа разделов:

1. Private - свойства и методы из этого раздела доступны только этому объекту. Другие объекты не могут вызывать эти методы и читать/записывать свойства;
2. Protected - эти свойства и методы доступны только этому объекту и потомкам (объектам, которые происходят от нашего и наследуют его свойства). Сторонние объекты не могут получить доступ к хранящимся здесь свойствам и методам;
3. Public - все, что описано здесь, доступно всем;
4. Published - когда будут писываться собственные компоненты приложения, в этом разделе мы будем описывать свойства и события, которые должны быть отображены в объектном инспекторе. Эти свойства доступны всем.

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

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

пример объявления глобальных переменных

В этом примере объявлена переменная Forml типа объекта TForml. Когда будет создан объект TForml, то его указатель будет записан в переменную Form1. Данная переменная глобальная и существует, пока программа выполняется, а значит, к ней всегда можно получить доступ.

Ключевое слово implementation тоже пока трогать не будем, а оставим на будущее, когда наши знания о Delphi немного расширятся. Последнее, что осталось рассмотреть в этой главе, - ключ {$R * dfm}.

В фигурных скобках могут быть не только комментарии, но и ключи для компилятора. Они отличаются тем, что выглядят как {$Буква Параметр]. Буква - указывает на тип ключа. В нашем случае используется буква R . Этот ключ указывает на то, что надо подключить файл ресурсов, в данном случае .dfm файл (файл с данными о визуальных объектах) с тем же именем, что и имя модуля. Если имя модуля Mainunit , то нужно изменить этот ключ на {$R MainUnit .dfm}. Ключ R - это единственный ключ, который пока понадобится.

Любой программный код в Delphi заключается между begin и end. Ключевое слово begin означает начало кода, a end - конец. Например, когда вы пишете процедуру, то сначала нужно написать ее имя (как это делать, мы поговорим позже), а потом заключить ее код между операторными скобками begin и end.

По материалам сайта

Страница 7 из 12

Классы

Структура тела класса

Тело класса при его декларации подчинено следующей структуре:

• Объявление полей;
• Объявление методов;
• Объявление свойств.

Уровни доступа

• Приватные (скрытые) члены класса (private );
• Защищенные члены класса (protected );
• Общедоступные члены класса (public );
• Публикуемые члены класса (published )

Таким образом, в Object Pascal существует четыре уровня доступа для членов класса: published, public, protected и private - в порядке уменьшения видимости. По умолчанию, уровень доступа - published. В общем, члены класса должны давать наименьший уровень доступа, который подходит для этого члена. Например, член, к которому имеют доступ классы из одного модуля должен иметь уровень доступа private. Кроме того, объявляя члены класса с наименьшим уровнем доступа, Вы позволяете компилятору воспользоваться дополнительными возможностями для оптимизации. С другой стороны, если Вы планируете в дальнейшем порождать дочерние классы от Вашего класса, то нужно использовать уровень доступа protected.

Никогда не указывайте уровень доступа public для данных. Данные всегда должны быть объявлены в приватной секции и доступ к ним должен осуществляться с помощью методов или свойств.

Объявление конструктора

Объявление методов