blob: b20307ea9638347985b3c2208b7c43d58e801f3c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
<p>
Documentation and comments are important tools for making your code easier to
work with and understand.
</p>
<p>
As well as regular <code>//</code> comments Gleam has <code>///</code> and
<code>////</code> comments which are used for attaching documentation to code.
</p>
<p>
<code>///</code> is used for documenting types and functions, and should be
placed immediately before the type or function it's documenting.
</p>
<p>
<code>////</code> is used for documenting modules, and should be placed
at the top of the module.
</p>
|
