Lazarus
Home
Help
TinyPortal
Search
Login
Register
Lazarus
»
Forum
»
Using the Lazarus IDE
»
Editor
»
How to insert a block comment for a new function
Free Pascal
Website
Downloads
Wiki
Bugtracker
Mailing List
Lazarus
Website
Downloads (Laz+FPC)
Packages (OPM)
FAQ
Wiki
Bugtracker
IRC channel
Developer Blog
Follow us on Twitter
Latest SVN
Mailing List
Other languages
Foundation
Website
Useful Wiki Links
Project Roadmap
Getting the Source
Screenshots
About donations (wiki)
Bookstore
Computer Math and Games in Pascal
(preview)
Lazarus Handbook
(preview only)
Search
Advanced search
Recent
Exeption-class "External:...
by
egsuh
[
Today
at 04:25:17 am]
dblookuplist question
by
daveinhull
[
Today
at 02:05:17 am]
Compiler case optimizatio...
by
winni
[
Today
at 01:28:23 am]
Tests results of several ...
by
lainz
[
Today
at 12:54:47 am]
What is faster string con...
by
lainz
[
Today
at 12:54:11 am]
Major Release: TMS FNC UI...
by
lazdeveloper
[December 10, 2019, 11:38:38 pm]
Synedit wants too more ke...
by
Martin_fr
[December 10, 2019, 10:33:33 pm]
Is posssible own MessageD...
by
wp
[December 10, 2019, 10:03:56 pm]
fpreport: FPReportdesign ...
by
af0815
[December 10, 2019, 09:48:06 pm]
BGRABitmap.Draw on TBitma...
by
winni
[December 10, 2019, 08:54:33 pm]
« previous
next »
Print
Pages: [
1
]
Author
Topic: How to insert a block comment for a new function (Read 4379 times)
vfclists
Hero Member
Posts: 825
How to insert a block comment for a new function
«
on:
March 15, 2010, 01:28:29 am »
I want to create block comments to describe functions. Is there a CodeTools macro for that?
The kind of information blocks source code documentation tools require
Logged
Windows - Lazarus 1.0.8/FPC 2.6.0
Linux - Lazarus 1.4.4 /FPC 2.6.4
guest62577
Guest
RE: How to insert a block comment for a new function;
«
Reply #1 on:
June 02, 2018, 07:04:36 pm »
creating comment for functions is simple, place a comment right before it's header under TYPE;
Code: Pascal
[Select]
UNIT1
INTERFACE
USES
TYPE
{...}
//this comment are displayed when hovering cursor at the function name;
function
examplefunction
:
boolean
;
[^]
however
Code: Pascal
[Select]
UNIT2
INTERFACE
USES
{...no type}
//this comment are displayed when hovering cursor at the function name from UNIT1 but not on UNIT2;
function
examplefunction_commentissue
:
boolean
;
IMPLEMENTATION
//comment from UNIT2 must be placed under implementation - thus an issue around this comment method;
function
examplefunction_commentissue
:
boolean
;
Logged
Martin_fr
Administrator
Hero Member
Posts: 5788
Re: How to insert a block comment for a new function
«
Reply #2 on:
June 02, 2018, 09:39:30 pm »
Not sure what there is (nor what exactly you need), but you can also look at "Code Templates", which include some macros.
Alternatively you can use pascal-script macros.
Logged
Print
Pages: [
1
]
« previous
next »
Lazarus
»
Forum
»
Using the Lazarus IDE
»
Editor
»
How to insert a block comment for a new function