Lazarus heeft een handige functie: Als je over code beweegt met de muis van b.v. een functie, procedure of variabele, dan laat het een hint venstertje zien met details zoals parameters en waar in source code het gedeclareerd is.
Je kunt dit echter, ook in jouw eigen code, uitbreiden met eigen commentaar. Hier een paar voorbeelden:
Variabelen:
var
MyVariable : integer; // Dit is een variabele voor mijn project
// Test variabele - dit werkt ook
TestVariabele : string;
Constanten:
const
// MediaTypes (werkt voor beide constanten)
MovieMedia = 1;
TVShowMedia = 2;
myDummy = 0; // Maar dit werkt ook
// Complexe constanten werken alleen maar 1-voor-1
TestConst : array[1..3] of integer;
(voor simpele constanten werkt het voor meerdere tegelijk, maar dat werk niet voor complexe constanten)
Functions en procedures in de implementation sectie:
// Deze functie geeft TRUE of FALSE terug
function TForm1.MijnFunction(MijnParameter:string):Boolean;
// Deze procedure doet iets met MijnParameter
procedure TForm1.MijnProcedure(MijnParameter:string);
In de interface sectie:
function MijnFunction(MijnParameter:string):Boolean; // Deze functie geeft TRUE of FALSE terug
procedure MijnProcedure(MijnParameter:string); // Deze procedure doet iets met MijnParameter
Als je nu ergens (maakt niet uit waar) in jouw code de muis over b.v. MijnFunction() laat zweven, dan zegt het hint venstertje zoiets als:
function MijnFunction(MijnParameter:string):Boolean;
/de/bestand/locatie/van/de/file.pas
Deze functie geeft TRUE or FALSE terug