Metodi di annotazione in Delphi?

Question

Ho una parte di codice che richiede una documentazione seria e volevo chiedere se una funzionalità simile alla documentazione XML in-code di C# /. NET è disponibile per Embarcadero Delphi. Il mio obiettivo è quello di visualizzare una sorta di informazioni su come utilizzare correttamente un metodo specifico nel modo in cui sarebbe evidenziato nel completamento automatico in Delphi XE3.

Qualcosa di simile (C#):

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

fa Delphi XE3 sostegno qualcosa di simile?

Grazie per la lettura.

Answer 1

La funzione è denominata Documentazione XML Commenti ed è documented here. Sembra che sia stato modellato da vicino sulla funzione .net equivalente, quindi dovresti essere a casa con esso.

La documentazione contiene questo esempio:

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

che si traduce in questo aiuto intuizione suggerimento:

e ci sono vari altri modi per elaborare e consumare la documentazione.