Phương pháp chú thích trong Delphi?

Question

Tôi có một đoạn mã cần một số tài liệu nghiêm túc và muốn hỏi liệu một tính năng tương tự như Tài liệu XML trong mã của C# /. NET có sẵn cho Embarcadero Delphi hay không. Mục tiêu của tôi là hiển thị một số loại thông tin về cách sử dụng một phương pháp cụ thể một cách chính xác theo cách nó sẽ được đánh dấu trong Tự động hoàn thành trong Delphi XE3.

Something như thế này (C#):

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

Liệu Delphi XE3 hỗ trợ một cái gì đó như thế này?

Cảm ơn bạn đã đọc.

Answer 1

Đối tượng địa lý được đặt tên là Tài liệu XML Nhận xét và là documented here. Nó dường như đã được mô hình chặt chẽ trên các tính năng tương đương. Net vì vậy bạn nên ở nhà với nó.

Các tài liệu chứa ví dụ này:

/// <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; 

mà kết quả trong trợ giúp này cái nhìn sâu sắc gợi ý:

Và có nhiều cách khác để xử lý và tiêu thụ các tài liệu hướng dẫn.