Metody adnotacji w Delphi?

Question

Mam kawałek kodu, który wymaga poważnego dokumentowania i chciałem zapytać, czy funkcja podobna do C#/.NET Dokumentacja XML w kodzie jest dostępna dla Embarcadero Delphi. Moim celem jest wyświetlenie informacji o tym, jak prawidłowo zastosować określoną metodę w taki sposób, aby była ona podświetlona w Autouzupełnianiu w Delphi XE3.

coś takiego (C#):

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

Czy Delphi XE3 wsparcie coś takiego?

Dziękuję za przeczytanie.

Answer 1

Funkcja nazywa się Dokumentacja XML Komentarze i jest documented here. Wygląda na to, że został dokładnie zamodelowany na równoważnej funkcji .net, więc powinieneś być z nim w domu.

Dokumentacja zawiera następujący przykład:

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

co skutkuje tym pomocy wglądu podpowiedź:

I istnieje wiele innych sposobów, aby proces i spożywają dokumentację.