55 lines
3.4 KiB
HTML
55 lines
3.4 KiB
HTML
<html>
|
||
|
||
<head>
|
||
<object type="application/x-oleobject" classid="clsid:1e2a7bd0-dab9-11d0-b93a-00c04fc99f9e">
|
||
<param name="Keyword" value="">
|
||
</object>
|
||
<meta http-equiv="Content-Type" content="text/html; charset=windows-1251">
|
||
<title></title>
|
||
<link rel="StyleSheet" href="../../default.css">
|
||
<style type="text/css">
|
||
.auto-style1 {
|
||
font-family: monospace;
|
||
font-size: 10pt;
|
||
color: #000080;
|
||
}
|
||
</style>
|
||
</head>
|
||
|
||
<body>
|
||
<H1>Документирующие комментарии</H1>
|
||
<p>Можно помечать заголовки процедур, функций, методов, имена классов, типов,
|
||
констант и переменных так называемыми документирующими комментариями.
|
||
Документирующие комментарии всплывают в подсказках редактора при наведении
|
||
курсора мыши на слово, при открытии скобки после имени подпрограммы и при выборе
|
||
поля из списка полей, выпадающих при нажатии точки после имени. Система
|
||
всплывающих подсказок в редакторе получила название Intellisense.</p>
|
||
<p>Документирующий комментарий располагается на строчке, предшествующей
|
||
помечаемому объекту, и начинается с символов <span class="auto-style1">///</span>.
|
||
Например:</p>
|
||
<blockquote>
|
||
<p><code><strong>const</strong> <br> /// Константа Pi<br> Pi =
|
||
3.14;<br><br><strong>type</strong><br> /// TTT - синоним целого типа<br>
|
||
TTT = integer;<br> /// Документирующий комментарий класса XXX<br>
|
||
XXX = <strong>class</strong><br> <strong>end</strong>;<br><br>///
|
||
Документирующий комментарий процедуры p<br><strong>procedure</strong> p(a :
|
||
integer);<br><strong>begin</strong><br><strong>end;</strong><br><br><strong>
|
||
var</strong> <br> /// Документирующий комментарий переменной t1<br>
|
||
t1: TTT;</code></p>
|
||
</blockquote>
|
||
<p>Документирующие комментарии могут занимать несколько строк, каждая из которых
|
||
должна начинаться с<code> ///</code> . Для комментирования
|
||
подпрограмм можно использовать в первой строке документирующий комментарий
|
||
<code>///-</code>, тогда его содержимое меняет заголовок
|
||
подпрограммы в подсказке при наведении курсора мыши. Например:</p>
|
||
<blockquote>
|
||
<p><code>///- Exclude(var s : set of T; el : T)<br>///Удаляет элемент el из
|
||
множества s<br><strong>procedure</strong> Exclude(<strong>var</strong> s:
|
||
TypedSet; el: object);</code></p>
|
||
</blockquote>
|
||
<p>Если первая строка документирующего комментария имеет вид
|
||
<code>///--</code>, то подсказка не всплывает. Это делается
|
||
для элементов, которые хочется скрыть от системы всплывающих подсказок.</p>
|
||
</body>
|
||
|
||
</html> |