Предложение indexing

Предложение indexing

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

index_word: index_value, index_value, ...

где index_word - произвольный идентификатор (элемент индексирования), а каждое значение index_value - произвольный элемент языка (идентификатор, целое число, строка и т.д.) (См. "Заметки об indexing", лекция 4).

Это дает два преимущества:

[x]. Читатели исходного текста получают сводку свойств класса без необходимости рассмотрения деталей.

[x]. В средах разработки с поддержкой повторного использования кода соответствующие инструментальные средства (часто называемые браузерами, навигаторами кода, инспекторами кода и т.д.) могут использовать информацию из данного раздела, помогая потенциальным пользователям найти нужные им классы. Эти средства обычно позволяют вести поиск по заданному шаблону среди элементов индексирования и их значений index_value.(В лекции 18 курса "Основы объектно-ориентированного проектирования" рассмотрен базовый механизм ОО-браузеров.)

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

Предложения indexing и комментарии к заголовку являются иллюстрацией правильного применения принципа самодокументирования (Self-Documentation principle): везде, где это возможно, документация модуля должна размещаться непосредственно в самом модуле. (См. "Самодокументирование", лекция 3)

Поделитесь на страничке

Следующая глава >

Похожие главы из других книг:

Специальное предложение для наших читателей!

Из книги автора

Специальное предложение для наших читателей! Если вы давно думаете – с какой стороны правильнее подойти к социальным сетям, как использовать их для дополнительного дохода, то сейчас у вас есть шанс!Мы, Николай Мрочковский, Андрей Парабеллум и Владимир Калаев, проведем


1. Предложение разных версий продукта

Из книги автора

1. Предложение разных версий продукта В продающем тексте вы можете предложить три версии своего продукта: «Стандартную», «Голд» и «Платинум». Однозначно, у вас будут заказывать не только стандарт. В запусках многих тренингов есть целая таблица разных


Предложение индивидуальной работы

Из книги автора

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


Убойное предложение

Из книги автора

Убойное предложение Первый элемент формулы – оффер (от англ. offer), или предложение. Ключ к написанию сильных предложений для интернет-магазина в том, чтобы давить на эмоции клиента, а не опираться на его логику. Ваше специальное предложение должно быть конкретным, четким и


1.5.3. Предложение case в Ruby

Из книги автора

1.5.3. Предложение case в Ruby Во всех современных языках есть та или иная форма многопутевого ветвления. В C/C++ и Java это предложение switch, а в Pascal — предложение case. Служат они одной и той же цели и функционируют примерно одинаково.Предложение case в Ruby похоже, но при ближайшем


Предложение работать «оператором WebMoney»

Из книги автора

Предложение работать «оператором WebMoney» Мошеннический прием, с которым мы познакомим вам в данном разделе, появился относительно недавно, но быстро завоевал популярность у интернет-злоумышленников.Сущность его заключается в том, что вам предлагается поработать


Предложение GROUP BY

Из книги автора

Предложение GROUP BY Когда запрос включает предложение GROUP BY, TO спецификация столбца и таблицы, а именно:SELECT {<список-столбцов>}FROM <спецификация-таблицы>[WHERE <условие-поиска>]передается следующей стадии обработки, где строки разделяются на одну или более вложенных


Совет 2 Предложение и спрос

Из книги автора

Совет 2 Предложение и спрос Когда интернет только начал входить в нашу жизнь, можно было хорошо заработать на создании простых HTML-страниц для фирм. Буквально каждый жаждал иметь собственную страничку, а вот создавать их умели немногие. Компании были готовы платить


Спрос и предложение на компьютерные развлечения

Из книги автора

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