Подтвердить что ты не робот

Аннотирование методов в Delphi?

У меня есть фрагмент кода, который требует серьезного документирования и хотел спросить, доступна ли функция, аналогичная XML-документации С#/.NET In-code для Embarcadero Delphi. Моя цель - показать какую-то информацию о том, как правильно использовать конкретный метод, как это было бы выделено в Autocompletion в Delphi XE3.

Что-то вроде этого (С#):

/// <summary>
/// Some useful information helping other developers use this method correctly
/// </summary>
public static void ADocumentedMethod();

Поддерживает ли Delphi XE3 что-то вроде этого?

Спасибо, что прочитали.

4b9b3361

ОТВЕТЫ

Ответ 1

Эта функция называется комментариями по документации XML и описанной здесь. Похоже, что он был тщательно смоделирован по эквивалентной функции .net, поэтому вы должны быть рядом с ней.

Документация содержит этот пример:

/// <summary> Removes the specified item from the collection
/// </summary>
/// <param name="Item">The item to remove
/// </param>
/// <param name="Collection">The group containing the item
/// </param>
/// <remarks>
/// If parameter "Item" is null, an exception is raised.
/// <see cref="EArgumentNilException"/>
/// </remarks>
/// <returns>True if the specified item is successfully removed;
/// otherwise False is returned.
/// </returns>
function RemoveItem(Item: Pointer; Collection: Pointer): Boolean;
begin
  // Non-XML DOC comment
  // ...
end;

что приводит к подсказке подсказки:

enter image description here

И есть другие способы обработки и использования документации.