2018-08-02 22:04:49 +03:00
|
|
|
|
<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>
|
2025-11-07 16:12:31 +03:00
|
|
|
|
<H1>Документирующие комментарии</H1>
|
|
|
|
|
|
<p>Можно помечать заголовки процедур, функций, методов, имена классов, типов,
|
|
|
|
|
|
констант и переменных так называемыми документирующими комментариями.
|
|
|
|
|
|
Документирующие комментарии всплывают в подсказках редактора при наведении
|
|
|
|
|
|
курсора мыши на слово, при открытии скобки после имени подпрограммы и при выборе
|
|
|
|
|
|
поля из списка полей, выпадающих при нажатии точки после имени. Система
|
|
|
|
|
|
всплывающих подсказок в редакторе получила название Intellisense.</p>
|
|
|
|
|
|
<p>Документирующий комментарий располагается на строчке, предшествующей
|
|
|
|
|
|
помечаемому объекту, и начинается с символов <span class="auto-style1">///</span>.
|
|
|
|
|
|
Например:</p>
|
2018-08-02 22:04:49 +03:00
|
|
|
|
<blockquote>
|
2025-11-07 16:12:31 +03:00
|
|
|
|
<p><code><strong>const</strong> <br> /// Константа Pi<br> Pi =
|
|
|
|
|
|
3.14;<br><br><strong>type</strong><br> /// TTT - синоним целого типа<br>
|
|
|
|
|
|
TTT = integer;<br> /// Документирующий комментарий класса XXX<br>
|
2018-08-02 22:04:49 +03:00
|
|
|
|
XXX = <strong>class</strong><br> <strong>end</strong>;<br><br>///
|
2025-11-07 16:12:31 +03:00
|
|
|
|
Документирующий комментарий процедуры p<br><strong>procedure</strong> p(a :
|
2018-08-02 22:04:49 +03:00
|
|
|
|
integer);<br><strong>begin</strong><br><strong>end;</strong><br><br><strong>
|
2025-11-07 16:12:31 +03:00
|
|
|
|
var</strong> <br> /// Документирующий комментарий переменной t1<br>
|
2018-08-02 22:04:49 +03:00
|
|
|
|
t1: TTT;</code></p>
|
|
|
|
|
|
</blockquote>
|
2025-11-07 16:12:31 +03:00
|
|
|
|
<p>Документирующие комментарии могут занимать несколько строк, каждая из которых
|
2025-11-11 22:04:03 +03:00
|
|
|
|
должна начинаться с<code> ///</code> . Для комментирования
|
2025-11-07 16:12:31 +03:00
|
|
|
|
подпрограмм можно использовать в первой строке документирующий комментарий
|
2025-11-11 22:04:03 +03:00
|
|
|
|
<code>///-</code>, тогда его содержимое меняет заголовок
|
2025-11-07 16:12:31 +03:00
|
|
|
|
подпрограммы в подсказке при наведении курсора мыши. Например:</p>
|
2018-08-02 22:04:49 +03:00
|
|
|
|
<blockquote>
|
2025-11-07 16:12:31 +03:00
|
|
|
|
<p><code>///- Exclude(var s : set of T; el : T)<br>///Удаляет элемент el из
|
|
|
|
|
|
множества s<br><strong>procedure</strong> Exclude(<strong>var</strong> s:
|
2018-08-02 22:04:49 +03:00
|
|
|
|
TypedSet; el: object);</code></p>
|
|
|
|
|
|
</blockquote>
|
2025-11-07 16:12:31 +03:00
|
|
|
|
<p>Если первая строка документирующего комментария имеет вид
|
2025-11-11 22:04:03 +03:00
|
|
|
|
<code>///--</code>, то подсказка не всплывает. Это делается
|
2025-11-07 16:12:31 +03:00
|
|
|
|
для элементов, которые хочется скрыть от системы всплывающих подсказок.</p>
|
2018-08-02 22:04:49 +03:00
|
|
|
|
</body>
|
|
|
|
|
|
|
|
|
|
|
|
</html>
|
