I am looking for a solution/help about Help Insight with summary tags. I am using Delphi Tokyo 10.2 Update 2.
1.) HelpInsight works and the function does have additional information
interface
type
TMyClass= class(TForm)
private
/// <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 TClass.TestFunction(Item: Pointer; Collection: Pointer): Boolean;
end;
2.) HelpInsight does not add additional information
implementation
/// <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 TClass.TestFunction(Item: Pointer; Collection: Pointer): Boolean;
begin
// Non-XML DOC comment
// ...
end;
I do not like to have summary XML Code in the interface. Is there any solution to get HelpInsight to take summary from implementation section?
It is not clearly stated in the docs, but there's one very little hint (bold text) that it does NOT work in the implemenation section:
View > Help Insight Shift+Ctrl+H
Displays a hint containing information about the symbol, such as type, file, location of declaration, and any XML documentation associated with the symbol (if available).
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With