Commenting guidelines

no-code-comments: Avoid code comments

Instead of adding comment marker on such line of codes which are outdated or not used we should remove them from the code document.

This approach can help improve code readability, reduce the risk of errors caused by outdated or misleading comments, and make it easier for developers to maintain and update the code in the future.
Not recommended
-- ftd.text: Hello World!
;; color: red
color: $inherited.colors.text
Recommended
-- ftd.text: Hello World!
color: $inherited.colors.text
comment-spacing: One character space after ;;
This practice helps to improve code readability. When writing comments using the ;; syntax in code, one should leave one character space between ;; and the comment text.
Not recommended
;;this is the comment line
Recommended
;; this is the comment line

Support fastn!

Enjoying fastn? Please consider giving us a star ⭐️ on GitHub to show your support!

Getting Help

Have a question or need help?

Visit our GitHub Q&A discussion to get answers and subscribe to it to stay tuned.

Join our Discord channel and share your thoughts, suggestion, question etc.

Connect with our community!

Found an issue?

If you find some issue, please visit our GitHub issues to tell us about it.

Join us

We welcome you to join our Discord community today.

We are trying to create the language for human beings and we do not believe it would be possible without your support. We would love to hear from you.
Copyright Β© 2023 - FifthTry.com