diff --git a/docs/guidelines/coding-style.md b/docs/guidelines/coding-style.md index aaf1e3e..7cca226 100644 --- a/docs/guidelines/coding-style.md +++ b/docs/guidelines/coding-style.md @@ -1,6 +1,6 @@ --- icon: material/code-braces -description: Hi +description: Use these guidelines when developing your projects, and they will also make it easier to understand when working with external APIs. --- # Coding style @@ -88,4 +88,4 @@ Highly recommended to place module declaration right after use statements with o + Use single-line comments (`//`) for brief explanations. + Place comments before the explanation part, not at the end of the line. + Begin comment with uppercase letter. -+ Insert one space between `//` and the comment text. \ No newline at end of file ++ Insert one space between `//` and the comment text.