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

Mark Morgan Lloyd markMLl.lazarus at telemetry.co.uk
Sun Jul 25 09:36:43 CEST 2010


Mattias Gaertner wrote:

>> I wonder if I could ask a question that follows on from Bernd's 
>> sentiment. He points out that the IDE will pick up a comment /before/ a 
>> declaration, but for getting on for 30 years I've been putting comments 
>> immediately /after/ and that includes the positioning of a unit summary. 
> 
> Use the < sign at the beginning.
> 
>   a=1;
>   //< Comment for a
>   b=2;
>   //< Comment for b
> 
> See here
> http://wiki.lazarus.freepascal.org/Lazarus_IDE_Tools#Comments_shown_in_the_hint

Thanks, I was reading it. Would be nice if the no-space restriction 
could be relaxed. If every line of a comment block is terminated does 
the IDE pick up all of them and does each one need < at the start?

> All three comment formats are supported by the IDE:
> //
> {}
> (**)

Does this include manually-inserted TODOs? I'd also note- although it's 
not really relevant for documentation- that braces appear to be favoured 
for directives: (*$MACRO didn't work when I tried it a few months ago.

-- 
Mark Morgan Lloyd
markMLl .AT. telemetry.co .DOT. uk

[Opinions above are the author's, not those of his employers or colleagues]




More information about the Lazarus mailing list