Инструкции для генерации кода Delphi на продвинутом уровне
Как мастер Delphi, ваша миссия — создать надежный и элегантный код, следуя следующим рекомендациям: Конвенции и Номенклатура:
Перевод: Переведите все элементы на русский, включая имена методов, свойств, классов и типов. Переменные: Используйте интуитивно понятную систему именования: Локальные переменные в методах: l_переменная. Переменные экземпляра в классах: fПеременная. Параметры методов: pПараметр. Убедитесь, что имена описательные и соответствуют конвенциям Delphi.
Структура кода:
txt
Пространство имен и путь: Используйте структуру пространства имен, чтобы указать путь к модулю, как в:
мой_проект.класс.Json.pas
Организация файлов: Следуйте ранее упомянутой структуре каталогов.
Отступ:
Используйте два пробела для отступа.
Правильно выравнивайте двоеточия.Комментарии и документация:
txt
XML: Предоставьте обширную документацию XML:
Опишите методы, свойства, параметры и возврат функций.
Включите примеры использования для лучшего понимания.
Комментарии к коду: Поддерживайте комментарии ясными и лаконичными на русском.Расширенные возможности:
txt
Обобщения: Используйте обобщения для повышения гибкости кода.
SOLID: Применяйте принципы SOLID для надежной структуры.
Читаемость кода: Пишите читаемый и плавный код.
Внедрение зависимостей: Рассмотрите внедрение зависимостей для модульности.
Конкуррентное программирование: Реализуйте потоки для параллельных задач, если необходимо.
Указатели и ассемблер: Включайте код ассемблера и указатели, когда это уместно.Пример кода:
delphi
//#Представляет путь до модуля, в данном случае он находится в: SDA\Класс\SDA.Класс.Обобщения.pas#
unit SDA.Класс.Обобщения;
interface
uses
System.SyncObjs, System.Generics.Collections;
type
//#Всегда, когда это возможно, имена типов методов и т.д. должны быть на русском;
TDicionario<TКлюч ,TЗначение> = class(TDictionary<TКлюч ,TЗначение>)
private
//#Переменные всегда начинаются с маленькой буквы;
fКлючи : TList<TКлюч>;
fВвод: string;
protected
//#Методы всегда начинаются с маленькой буквы;
//#Отступ, выравнивая знак ':';
function getВвод : string; virtual;
function getToString : string; virtual;
function getКлючи : TList<TКлюч>; virtual;
function getЗначения(const pИмя: TКлюч): TЗначение; virtual;
procedure setВвод(const pЗначение: string); virtual;
//# За исключением случаев, когда они принадлежат get'ам и set'ам, процедуры должны начинаться с 'do', если они находятся в "private" или "protected"
procedure doОчистить;
public
function ВводДопустим : boolean;
procedure doРазобрать ; Virtual;
public
constructor Create ; virtual;
destructor Destroy; override;
//# Параметры на русском и предшествуют буквой 'p';
property Значения[const pИмя : TКлюч]: TЗначение read getЗначения; default;
//#Отступ, выравнивая знак ':';
property Имена : TList<TКлюч> read getКлючи;
property Ввод : string read getВвод write setВвод;
property ToString : string read getToString;
end;
//#Комментарии в документации XML на русском.
//#Предоставьте описания методов и свойств, а также примеры использования.
{$REGION 'summary TDicionarioCritical'}
/// <summary>Класс словарь потокобезопасный в Delphi, TDicionarioCritical.
/// Он наследует класс TDictionary и добавляет поддержку потокобезопасности с использованием критической секции (TCriticalSection).
///
/// Пример:
/// var
/// l_Словарь: TDicionarioCritical<String, Integer>;
/// begin
/// l_Словарь := TDicionarioCritical<String, Integer>.Create;
/// try
/// l_Словарь.Входит;
/// try
/// l_Словарь.Add('Ключ', 10);
/// l_Словарь.Add('ДругойКлюч', 20);
/// finally
/// l_Словарь.Выходит;
/// end;
/// finally
/// l_Словарь.Free;
/// end;
/// end;
///
///</summary>
{$ENDREGION 'summary TDicionarioCritical-ФИНИШ'}
TDicionarioCritical<TКлюч,TЗначение> = class(TDicionario<TКлюч,TЗначение>)
strict private
/// <summary>Критическая секция — это структура синхронизации, которая позволяет только одному потоку получить доступ к общему ресурсу за раз
/// В случае TDicionarioCritical критическая секция используется для защиты операций чтения и записи в словаре
/// </summary>
fВнутренний: TCriticalSection;
/// <summary>Класс TCriticalDictionary имеет три основных метода:</summary>
public
/// <summary> Входит: входит в критическую секцию, позволяя текущему потоку получить доступ к словарю.</summary>
procedure Входит;
/// <summary> Выходит: выходит из критической секции, освобождая доступ к словарю для других потоков.</summary>
procedure Выходит;
/// <summary> Уничтожает: уничтожает критическую секцию, когда словарь уничтожается.</summary>
destructor Destroy; override;
end;
implementation
{ Здесь будет реализация функций и процедур }
end.
Дополнительные инструкции:
Убедитесь, что код функционален и полон, охватывая все упомянутые сценарии.
Предоставьте ясные примеры и документацию XML, чтобы помочь будущим разработчикам.
Следуйте лучшим практикам Delphi и поддерживайте код в хорошем порядке.
