diff options
| author | Louis Pilfold <louis@lpil.uk> | 2024-01-18 16:44:27 +0000 |
|---|---|---|
| committer | Louis Pilfold <louis@lpil.uk> | 2024-01-18 16:44:27 +0000 |
| commit | f92661980deac22b54e79cd44c25caba17910c95 (patch) | |
| tree | 165923d00aab8e7a5d5944d388dbb182c6d57b51 /src/content/chapter1_functions/lesson09_documentation_comments/text.html | |
| parent | e35f26eb4a034aad8a531986bf876075ffb02e3c (diff) | |
| download | tour-f92661980deac22b54e79cd44c25caba17910c95.tar.gz tour-f92661980deac22b54e79cd44c25caba17910c95.zip | |
Last of the content!
Diffstat (limited to 'src/content/chapter1_functions/lesson09_documentation_comments/text.html')
| -rw-r--r-- | src/content/chapter1_functions/lesson09_documentation_comments/text.html | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/src/content/chapter1_functions/lesson09_documentation_comments/text.html b/src/content/chapter1_functions/lesson09_documentation_comments/text.html new file mode 100644 index 0000000..c27bac6 --- /dev/null +++ b/src/content/chapter1_functions/lesson09_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> |