Want to try fastn for your company's website?
Book a Demo

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
Lang:
ftd
Recommended
-- ftd.text: Hello World!
color: $inherited.colors.text
Lang:
ftd
comment-spacing: One character space after `
This practice helps to improve code readability. When writing comments using the ` the comment text.
Not recommended
;;this is the comment line
Lang:
ftd
Recommended
;; this is the comment line
Lang:
ftd