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
Documentation
Bugtracker
Mailing List
Lazarus
Website
Downloads (Laz+FPC)
Packages (OPM)
FAQ
Wiki
Documentation (RTL/FCL/LCL)
Bugtracker
CCR Bugs
IRC channel
GIT
Mailing List
Other languages
Foundation
Website
Useful Wiki Links
Project Roadmap
Getting the Source
Screenshots
How to use the forum
About donations (wiki)
Bookstore
Computer Math and Games in Pascal
(preview)
Lazarus Handbook
Search
Advanced search
Recent
Controlling the behavior ...
by
rvk
[
Today
at 08:31:48 am]
A "leisure" question on W...
by
Awkward
[
Today
at 07:59:12 am]
Free AI to use in local
by
Thaddy
[
Today
at 07:36:24 am]
Big Numbers Math
by
Thaddy
[
Today
at 07:22:49 am]
how to change the color f...
by
Thaddy
[
Today
at 07:14:33 am]
Parquet?
by
Thaddy
[
Today
at 07:11:17 am]
STARS and Regular POLYGON...
by
Boleeman
[
Today
at 06:41:41 am]
Offical launch of the 1 B...
by
Gustavo 'Gus' Carreno
[
Today
at 05:53:09 am]
Project fails on run but ...
by
jamie
[
Today
at 12:54:49 am]
Curling Pythagoras Tree: ...
by
Boleeman
[
Today
at 12:00:37 am]
Ribbon bar in Lazarus 3.2...
by
wp
[March 28, 2024, 11:29:17 pm]
how to search in rxmemory...
by
rcmz
[March 28, 2024, 10:19:54 pm]
Configure JCF messages
by
GordonFindlay
[March 28, 2024, 10:16:19 pm]
Poll: Watches and Display...
by
Martin_fr
[March 28, 2024, 10:15:08 pm]
Dialog ShowModal and an i...
by
d7_2_laz
[March 28, 2024, 09:51:39 pm]
JEDI error but unit compi...
by
Thaddy
[March 28, 2024, 09:30:33 pm]
Understanding and adjusti...
by
circular
[March 28, 2024, 09:09:56 pm]
Dynarray initialization p...
by
Thaddy
[March 28, 2024, 06:30:12 pm]
Zeos components. Had to c...
by
Fantablup
[March 28, 2024, 04:17:13 pm]
[SOLVED] Completion box s...
by
furious programming
[March 28, 2024, 04:12:26 pm]
[LAMW] How to create a ca...
by
af0815
[March 28, 2024, 03:48:16 pm]
Complex package installat...
by
wp
[March 28, 2024, 03:38:16 pm]
[SOLVED] Combined pointer...
by
CM630
[March 28, 2024, 02:48:41 pm]
Using KeyPress event, how...
by
Zvoni
[March 28, 2024, 02:24:42 pm]
a Unit problem?
by
Thaddy
[March 28, 2024, 01:56:12 pm]
« previous
next »
Print
Pages: [
1
]
Author
Topic: How to insert a block comment for a new function (Read 5794 times)
vfclists
Hero Member
Posts: 1013
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
Lazarus 3.0/FPC 3.2.2
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: 9794
Debugger - SynEdit - and more
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
From the wiki:
Ide Tools, Code completion and more
/
IDE cool features
/
Debugger Status
Print
Pages: [
1
]
« previous
next »
Lazarus
»
Forum
»
Using the Lazarus IDE
»
Editor
»
How to insert a block comment for a new function
TinyPortal
© 2005-2018