Skip to content

Commit 4fd758a

Browse files
committed
add documenting comments and linking it
1 parent 0b4206e commit 4fd758a

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

docs/tablet-2-basic-syntax.txt

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,13 +71,27 @@ compiler to ignore the rest of the line.
7171
Multi Line
7272
----------
7373

74-
If many lines has to be commented, use "**#\`**" followed by any pair
75-
of braces that surround the comment.
74+
If many lines has to be commented,
75+
use "**[\#\`](appendix-a-index.html#pound-apostrophe)**"
76+
followed by any pair of braces that surround the comment.
7677

7778
$things = #`( i wonder how many of these
7879
I will need, hm maybe 3, or 4, better 5 ) 5; # same as $things = 5;
7980

8081

82+
Documenting Comments
83+
--------------------
84+
85+
When adding an equal sign after the pound like
86+
**[#=](appendix-a-index.html#pound-equal)**, it can be used to comment
87+
a subroutine of method that has this description stored.
88+
It's accessible via the *[WHY](#WHY-introspection)* introspection method
89+
of the routine object.
90+
91+
#= ...
92+
sub {
93+
...
94+
}
8195

8296
POD
8397
---

0 commit comments

Comments
 (0)