Delphi 源代码规范指南

本指南为 Delphi 开发者提供一套清晰、一致的代码规范，以提高代码可读性、可维护性和可协作性。

命名规范

• 变量和常量: 使用驼峰命名法，首字母小写，例如 userName， numberOfUsers。
• 类型: 使用 Pascal 命名法，首字母大写，例如 TUser， TUserList。
• 函数和过程: 使用 Pascal 命名法，首字母大写，动词或动词短语，例如 GetUser， CalculateTotal。

缩进和空格

• 使用 4 个空格进行缩进。
• 在运算符两侧添加空格，例如 x := y + z;。
• 在逗号后添加空格，例如 function MyFunction(param1: Integer, param2: String): Boolean;。

注释

• 使用 // 进行单行注释。
• 使用 (* ... *) 进行多行注释。
• 为所有公共类型、函数和过程编写清晰简洁的注释。

代码组织

• 将相关的代码块分组在一起。
• 使用空行分隔代码逻辑块。
• 保持代码行长度不超过 80 个字符。

其他规范

• 避免使用全局变量。
• 尽量使用 try...finally 块来确保资源释放。
• 遵循 Delphi 语言的最佳实践和惯例。

示例

unit MyUnit;

interface

uses
  SysUtils;

type
  TMyClass = class
  private
    FName: string;
  public
    property Name: string read FName write FName;
    function GetGreeting(const aName: string): string;
  end;

implementation

function TMyClass.GetGreeting(const aName: string): string;
begin
  Result := 'Hello, ' + aName + '!';
end;

end.