diff options
| author | Louis Pilfold <louis@lpil.uk> | 2023-12-09 15:21:10 +0000 |
|---|---|---|
| committer | Louis Pilfold <louis@lpil.uk> | 2023-12-09 15:21:10 +0000 |
| commit | 437d456cd504ca4124ef72ea4fb1576ec29563cd (patch) | |
| tree | 5c21e132658aa98276024e6c6eb3801d74b89078 /lessons/src/lesson099_documentation_comments/text.html | |
| parent | c093b83c9c5ad3ba92e9153569be6e27476403ea (diff) | |
| download | tour-437d456cd504ca4124ef72ea4fb1576ec29563cd.tar.gz tour-437d456cd504ca4124ef72ea4fb1576ec29563cd.zip | |
More on functions
Diffstat (limited to 'lessons/src/lesson099_documentation_comments/text.html')
| -rw-r--r-- | lessons/src/lesson099_documentation_comments/text.html | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/lessons/src/lesson099_documentation_comments/text.html b/lessons/src/lesson099_documentation_comments/text.html new file mode 100644 index 0000000..c27bac6 --- /dev/null +++ b/lessons/src/lesson099_documentation_comments/text.html @@ -0,0 +1,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 is documenting. +</p> +<p> + <code>////</code> is used for documenting modules, and should be placed + at the top of the module. +</p> |