Documentation comments
Documentation and comments are important tools for making your code easier to work with and understand.
As well as regular //
comments Gleam has ///
and
////
comments which are used for attaching documentation to code.
///
is used for documenting types and functions, and should be
placed immediately before the type or function it is documenting.
////
is used for documenting modules, and should be placed
at the top of the module.