Skip to content
Filtrera

Comments

Comments are an essential part of programming, allowing you to include notes, explanations, and descriptions within your code. Filtrera supports both single-line and multi-line comments, providing flexibility for documenting your scripts. This article covers the syntax and usage of comments in Filtrera.

Single-Line Comments

Single-line comments in Filtrera start with // and extend to the end of the line. They are useful for brief notes or explanations.

Syntax

// This is a single-line comment

Example

let age = 30 // Define the age variable and set it to 30

In this example, the comment explains that the age variable is being defined and set to 30.

Multi-Line Comments

Multi-line comments in Filtrera are enclosed between /* and */. They are useful for longer descriptions or for commenting out blocks of code.

Syntax

/* This is a multi-line comment
   It can span multiple lines */

Example

/* This function calculates the area of a rectangle.
   It takes the width and height as parameters
   and returns the computed area. */
param width: number
param height: number


from width * height

In this example, the multi-line comment provides a detailed description of the function and its parameters.

Commenting Out Code

Both single-line and multi-line comments can be used to temporarily disable parts of your code without deleting them. This is useful for debugging or testing different code sections.

Example

Using single-line comments to comment out code:

let age = 30
// let height = 180


from age * 2

In this example, the line defining height is commented out and will not be executed.

Using multi-line comments to comment out code:

/*
param width: number
param height: number


from width * height
*/


let age = 30
from age * 2

In this example, the block of code defining the parameters width and height and the calculation is commented out, so only the age calculation will be executed.

Best Practices

  • Use Comments Sparingly: Comments should enhance code readability without overwhelming the code. Use them to explain complex logic or provide context.
  • Keep Comments Updated: Ensure that comments are updated to reflect any changes in the code to avoid confusion.
  • Meaningful Comments: Write meaningful comments that provide value and context to the reader. Avoid stating the obvious.

Summary

Comments in Filtrera help you document your code and make it more understandable for yourself and others. By using single-line and multi-line comments effectively, you can provide valuable insights into the functionality and purpose of your code. Remember to use comments judiciously and keep them up-to-date to maintain clear and accurate documentation within your scripts.