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.
通常の //
コメントだけでなく、Gleam には ///
と ////
コメントがあり、コードにドキュメンテーションを添付するために使用します。
///
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.
モジュールの説明には ////
を使用し、モジュールの先頭に記述します。