diff options
Diffstat (limited to 'docs/LEARN.md')
| -rw-r--r-- | docs/LEARN.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/LEARN.md b/docs/LEARN.md index 8b0e1e6..b649b4f 100644 --- a/docs/LEARN.md +++ b/docs/LEARN.md @@ -915,7 +915,7 @@ output: the language server reports informational hints for likely mistakes. by default, `hints on;` shows blue informational squiggles. `hints small;` keeps the same hints but displays compact dots; it does not reduce their number or kinds. `hints off;` suppresses hints after the directive. each setting applies from its source position. -an inline block comment immediately before a numeric literal marks that literal as intentional and suppresses its magic-number hint. a comment before another operand does not suppress the hint. a block comment immediately above a declaration provides hover documentation; `//:` marks an implementation note instead. +an inline block comment immediately before a numeric literal marks that literal as intentional and suppresses its magic-number hint. a comment before another operand does not suppress the hint. block comments are for this kind of place, between code on one line; a comment on lines of its own is written with `//`. the `//` comment immediately above a declaration is its hover documentation. [example source](../examples/learn/29-block-comments.zc): @@ -923,7 +923,7 @@ an inline block comment immediately before a numeric literal marks that literal namespace; include rt; -/* adds a memory offset to an address. */ +// adds a memory offset to an address. int offset_address(int address) { return address + /* offset in memory */ 0x40ff; } |