diff options
| author | Louis Pilfold <louis@lpil.uk> | 2023-12-21 14:03:41 +0000 |
|---|---|---|
| committer | Louis Pilfold <louis@lpil.uk> | 2023-12-21 14:03:41 +0000 |
| commit | 4efb34bd728732101432843ed0bfbeb971272287 (patch) | |
| tree | 71b3b767c417809d92280cec64424c31c9a475be /src/content/chapter1_functions/lesson099_documentation_comments/text.html | |
| parent | 2a6ae1fa5408247c95bf4a7d59e5038342a2a125 (diff) | |
| download | tour-4efb34bd728732101432843ed0bfbeb971272287.tar.gz tour-4efb34bd728732101432843ed0bfbeb971272287.zip | |
Add chapters
Diffstat (limited to 'src/content/chapter1_functions/lesson099_documentation_comments/text.html')
| -rw-r--r-- | src/content/chapter1_functions/lesson099_documentation_comments/text.html | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/src/content/chapter1_functions/lesson099_documentation_comments/text.html b/src/content/chapter1_functions/lesson099_documentation_comments/text.html new file mode 100644 index 0000000..c27bac6 --- /dev/null +++ b/src/content/chapter1_functions/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> |