Книга: Описание языка PascalABC.NET
Документирующие комментарии
Документирующие комментарии
Можно помечать заголовки процедур, функций, методов, имена классов, типов, констант и переменных так называемыми документирующими комментариями. Документирующие комментарии всплывают в подсказках редактора при наведении курсора мыши на слово, при открытии скобки после имени подпрограммы и при выборе поля из списка полей, выпадающих при нажатии точки после имени. Система всплывающих подсказок в редакторе получила название Intellisense.
Документирующий комментарий располагается на строчке, предшествующей помечаемому объекту, и начинается с символов ///. Например:
const
/// Константа Pi
Pi = 3.14;
type
/// TTT - синоним целого типа
TTT = integer;
/// Документирующий комментарий класса XXX
XXX = class
end;
/// Документирующий комментарий процедуры p
procedure p(a : integer);
begin
end;
var
/// Документирующий комментарий переменной t1
t1: TTT;
Документирующие комментарии могут занимать несколько строк, каждая из которых должна начинаться с /// . Для комментирования подпрограмм можно использовать в первой строке документирующий комментарий ///-, тогда его содержимое меняет заголовок подпрограммы в подсказке при наведении курсора мыши. Например:
///- Exclude(var s : set of T; el : T)
///Удаляет элемент el из множества s
procedure Exclude(var s: TypedSet; el: object);
Если первая строка документирующего комментария имеет вид ///--, то подсказка не всплывает. Это делается для элементов, которые хочется скрыть от системы всплывающих подсказок.
Оглавление книги
- 1.2.2. Комментарии и встроенная документация
- Как создавать комментарии к файлам?
- Комментарии к алгоритму Тоома—Кука
- Строки кода и комментарии
- Комментарии в программе
- Комментарии
- Комментарии к примеру простой системы "производитель
- Комментарии по поводу реализации объекта порогового барьера
- Комментарии по поводу функций управления очередью с точки зрения производительности
- Комментарии по поводу многоступенчатого конвейера
- Комментарии по поводу клиент-серверного процессора командной строки
- Комментарии по поводу многопоточных моделей