Документировать процедуру

Рис. 16.32. Кнопка надстройки на панели Edit

Рассмотрим работу надстройки на следующем несложном примере:

1. Откройте окно программы для модуля, в который добавляются комментарии. В нашем примере следует открыть окно программы для конструктора Connect.

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

GetProcedureName().

3. Нажмите кнопку CodeDoc - Ргос на панели Edit.

4. При запуске надстройки в процедуру автоматически включается блок комментариев. Его примерный вид показан на рис. 16.33.

Рис. 16.33 Блок комментариев на уровне процедуры

Комментарий готов, вам остается лишь заполнить пару строк. Если в процедуру будут внесены какие-либо изменения, включите их описание в комментарий. Хорошие комментарии — залог жизнеспособности и устойчивости вашей программы. Они не только упрощают чтение кода, но и оказываются особенно полезными при работе в составе группы. Впрочем, даже если вы работаете в одиночку, комментарии все равно важны. Представьте себе, что через год вам потребуется внести в программу какие-нибудь изменения или исправить ошибку. Будете ли вы помнить весь исходный текст программы и логику ее работы после столь длительного перерыва?

Что нового мы узнали?

В этом уроке мы научились:

0 Пользоваться надстройками для упрощения работы над приложением.

0 Пользоваться диспетчером и панелью надстроек для подключения надстроек к IDE.

0 Создавать свои собственные надстройки с помощью шаблона Add-In.

0 Пользоваться надстройками семейства CodeDoc для последовательного документирования текста программы.

17 урок

Использование ActiveX

Платформа Active: общие сведения

Роль ActiveX в разработке программного обеспечения