gbdev/rgbds
1
0
Fork 0
mirror of https://github.com/gbdev/rgbds.git synced 2025-11-20 18:22:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

documentation for block comments

Browse Source
This commit is contained in:
anderoonies
2020-10-16 19:19:23 -04:00
committed by ISSOtm
parent 55be77be69
commit 5230104852
1 changed files with 12 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
src/asm/rgbasm.5
View File

@@ -47,13 +47,22 @@ The assembler
.Em always .Em always
ignores comments and their contents. ignores comments and their contents.
.Pp .Pp
There are two syntaxes for comments. The most common is that anything that follows a semicolon There are three syntaxes for comments. The most common is that anything that follows a semicolon
.Ql \&; .Ql \&;
not inside a string, is a comment until the end of the line. not inside a string, is a comment until the end of the line.
The other is that lines beginning with a The second is a block comment, beginning with
.Ql /*
and ending with
.Ql */ .
It can be split across multiple lines, or occur in the middle of an expression:
.Bd -literal -offset indent
X = /* the value of x
should be 3 */ 3
.Ed
The third is that lines beginning with a
.Ql * .Ql *
(not even spaces before it) are ignored. (not even spaces before it) are ignored.
This second syntax is deprecated (will be removed in a future version) and should be replaced with the first one. This third syntax is deprecated (will be removed in a future version) and should be replaced with either of the first two.
.Pp .Pp
Sometimes lines can be too long and it may be necessary to split them. Sometimes lines can be too long and it may be necessary to split them.
To do so, put a backslash at the end of the line: To do so, put a backslash at the end of the line: