metodo - Anotar métodos en Delphi?

metodo delphi ejemplos resueltos

Question

Tengo un código que necesita documentación seria y quería preguntar si una característica similar a la documentación XML en código de C # / .NET está disponible para Embarcadero Delphi. Mi objetivo es mostrar algún tipo de información sobre cómo utilizar un método específico correctamente de la manera en que se destacaría en Autocompletar en Delphi XE3.

Algo como esto (C #):

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

¿Delphi XE3 es compatible con algo como esto?

Gracias por leer.

Answer 1

La función se denomina Comentarios de documentación XML y está documentada aquí . Parece que se ha modelado de cerca en la función .net equivalente, por lo que debería estar en casa con ella.

La documentación contiene este ejemplo:

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

que da como resultado esta sugerencia de información de ayuda:

Y hay otras formas de procesar y consumir la documentación.