HelpInsight's XML documentation does not work every time

In Delphi 2007, I ran into some issues regarding XML documentation. Sometimes it works, sometimes not. At the moment, it almost never works. I noticed that there are similar problems already mentioned , but these workarounds do not work for me. Does anyone know how to fix the HelpInsight error, or what alternative should I document the source code so that it can be visible inside the IDE?

Here is just an example. In this example, 3/4 of the documentation works. In my real project, maybe 1-2 out of 50 work.

enter image description here


Refresh A few more screenshots:

This is a common class procedure.

enter image description here

and the procedure is called somewhere else in the class.

enter image description here

HelpInsight does not provide help.

+5
source share
1 answer

The error you describe is an error, at least in Delphi 2010, but fixed in Delphi XE4 (I do not have XE..XE3 installed and cannot verify). You yourself discovered that a workaround is used to indicate the name of a procedure / function with the name of the nodes in the implementation.

It should also be noted that when calling a procedure in another place in the code, for example,

procedure WhatEver; begin xx end; 

will display the HelpInsight document as expected when you hover over xx .

Finally, no help can be provided for your HelpInsight application that works only 1 or 2 of 50 times if you do not show examples.

0
source

Source: https://habr.com/ru/post/1241008/


All Articles