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

[Mattias Gaertner]

On Sun, 25 Jul 2010 07:36:43 +0000
Mark Morgan Lloyd <markMLl.lazarus at telemetry.co.uk> wrote:

> 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. 

Maybe eventually a per unit flag can be set to relax this.


> 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?

You mean:

a=1;
//< Comment for a
//< another comment for a

 
> > All three comment formats are supported by the IDE:
> > //
> > {}
> > (**)
> 
> Does this include manually-inserted TODOs?

The todo list supports all three styles.


>  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.

Yes. That's a fpc decision.


Mattias