Comment's Modifier questions
lazarus / 9-Editor

----------------------------------------------------------------------
garlar27 · 2012-04-18 16:57

Once I red something about "comment's modifiers" like "<" and many
others which I don't remember (I don't remember where I did read about
them too).

The "<" comment's modifier indicates that this comment belongs to what
ever is at the left of it. and it works great with Properties and
variables but NOT with procedures neither with functions.

Lets see this silly example:
Code: [Select]program HelloWorld;

{$mode objfpc}{$H+}

uses
  {$IFDEF UNIX}{ $IFDEF UseCThreads}
  cthreads,
  { $ENDIF}{$ENDIF}
  Interfaces, // this includes the LCL widgetset
  SysUtils;

type
   TMyClass = class(TObject)
   private
      // Comment before FVariable
      FVariable: string; //< Comment after FVariable
   public
      // comment before SomeProcess
      procedure SomeProcess; //< Comment after SomeProcess
      // Comment before Variable
      property Variable: string read FVariable write FVariable; //<
Comment after Variable
   end;

procedure TMyClass.SomeProcess;
begin
   // some code
   FVariable := 'HELLO WORLD';
end;

var
   MyObj: TMyClass;

begin
   MyObj := TMyClass.Create;
   MyObj.Variable := '';// if Mouse hover Variable a hint WITH the
comments before and after Variable will be shown
   MyObj.SomeProcess;// if Mouse hover SomeProcess a hint WITH the
comments before SomeProcess will be shown but not the comment after
SomeProcess
   WriteLN(MyObj.Variable);
   MyObj.Free;
end.

Should I report this in the bug tracker?

Someone knows where I can find the full list of those comment's
modifiers?

----------------------------------------------------------------------
Martin_fr · 2012-04-18 18:31

Depends on the context:

In the IDE for showing comments as part of the help-hint:
http://wiki.lazarus.freepascal.org/Lazarus_IDE_Tools#Hints_from_commen
ts

Similar syntax is used by documentation tools like pasdoc.