【Delphi 基础知识 17】注释代码的几种方法

在 Delphi 中，有三种主要的注释代码的方法，分别是：

花括号 {} 注释：这是一种常见的注释方式，在代码中使用花括号将注释的内容括起来。这种注释方式可以用于单行注释和多行注释。
```
// 单行注释
{ 这是一个多行注释可以跨越多行
}
```
双斜杠 // 注释：这是另一种常见的注释方式，使用双斜杠可以在代码中添加单行注释。
```
// 这是一个单行注释
```
也可以将 // 放在一行代码的末尾，表示该行剩余的部分都是注释。
```
WriteLn('Hello, World!'); // 这是一个行尾注释
```
大括号 ( ) 注释：使用 (* 和 *) 可以创建多行注释。这种注释方式也支持跨越多行。
```
(* 这是一个多行注释可以跨越多行
*)
```

这些注释方式在 Delphi 中都是有效的，开发者可以根据自己的习惯和项目的规范选择使用哪种注释方式。注释对于代码的可读性和维护性非常重要，因此建议在编写代码时养成添加注释的好习惯。

新注释

Delphi 10.4 Sydney 引入了一种新的注释语法，称为 “Delphi Documentation Comments”，用于支持更丰富的文档生成和 IDE 提示。

摘要

/// <summary>
/// 这是摘要
/// </summary>

描述

/// <remarks>
/// 这是描述
/// </remarks>

参数的名称和描述

/// <param name="变量名">类型</param>

/// <returns>返回值</returns>
<param name=""></param>：参数的名称和描述
/// <param name="变量名">类型</param>

以下是一个简单的示例：

/// <summary>
///   This is a summary comment for the class.
/// </summary>
TMyClass = class
privateFValue: Integer;
public/// <summary>///   Gets or sets the value./// </summary>/// <remarks>///   Additional remarks can be added here./// </remarks>property Value: Integer read FValue write FValue;
end;/// <summary>
///   Calculates the sum of two integers.
/// </summary>
/// <param name="a">
///   The first integer operand.
/// </param>
/// <param name="b">
///   The second integer operand.
/// </param>
/// <returns>
///   The sum of the two integers.
/// </returns>
function AddIntegers(a, b: Integer): Integer;