[Lazarus] comments in source [Re: "show declaration hints" has more power in it than is really used]

[Martin]

On 24/07/2010 13:24, Bernd wrote:
> Also I have noticed that in many of the rare occasions where a class
> has a documentation like here:
>
>    { TSynTextFoldAVLTree
>      Nodes in the tree cover the folded lines only
>      the cfCollapsed line at the start of a fold, is *not* part of a node.
>      RemoveFoldForline has special precaution for this.
>    }
>
>    TSynTextFoldAVLTree = class
>
> It is used the wrong way. The empty line will make make the comment
> effectively invisible for the hint- or help system
Never noticed that, as I didnt rely on this.
I simply find the code itself more readable if a multi-line comment is 
separated by a line from the class below.

Then again, in *this* *case* this comment is for an internally only used 
class, usable only for people working inside this unit. So you read it 
as you explore the source, rather than in the hint.

>   and also there are
> many comments that consist only of the name of the class that follows
> afterwards:
>
>    { TSynFoldNodeInfoHelper }
>
>    TSynFoldNodeInfoHelper = class
>    
They are automatically created by codetools...

Martin