PABCNetHelp/LangGuide/Modules/doccomments.html - master - n-dimens/pascalabcnet

PABCNetHelp/LangGuide/Modules/doccomments.html
55 строк3 KB
samuraiGH
adding working-tree-encoding attribute (#3325)
07 ноя 2025, 16:12
07 ноя 2025, 16:12cf1fd29
<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>&nbsp; /// Константа Pi<br>&nbsp; Pi = 
	3.14;<br><br><strong>type</strong><br>&nbsp; /// TTT - синоним целого типа<br>&nbsp; 
	TTT = integer;<br>&nbsp; /// Документирующий комментарий класса XXX<br>&nbsp; 
	XXX = <strong>class</strong><br>&nbsp; <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>&nbsp; /// Документирующий комментарий переменной t1<br>&nbsp; 
	t1: TTT;</code></p>
</blockquote>
<p>Документирующие комментарии могут занимать несколько строк, каждая из которых 
должна начинаться с<span class="auto-style1"> ///</span> . Для комментирования 
подпрограмм можно использовать в первой строке документирующий комментарий
<span class="auto-style1">///-</span>, тогда его содержимое меняет заголовок 
подпрограммы в подсказке при наведении курсора мыши. Например:</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>Если первая строка документирующего комментария имеет вид
<span class="auto-style1">///--</span>, то подсказка не всплывает. Это делается 
для элементов, которые хочется скрыть от системы всплывающих подсказок.</p>
</body>

</html>