From 437d456cd504ca4124ef72ea4fb1576ec29563cd Mon Sep 17 00:00:00 2001
From: Louis Pilfold <louis@lpil.uk>
Date: Sat, 9 Dec 2023 15:21:10 +0000
Subject: More on functions

---
 lessons/src/lesson099_documentation_comments/text.html | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 lessons/src/lesson099_documentation_comments/text.html

(limited to 'lessons/src/lesson099_documentation_comments/text.html')

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>
-- 
cgit v1.2.3