Comments in Calculated fields?

[Djmiles]

I'm trying to work out if it is possible to add comments to calculated fields? I've seen sources that suggest it is possible using a single or a double hashtag, however I get an error whenever I try this.

Is there a way? I want to be able to build in documentation

[marcwo]

Hi

did some digging internally and there does not seem to be a way to add comments.

I also tried a few options on a BigQuery datasource without success. Sorry!

[lauratilton]

I am able to add comments to a calculated field using a double hashtag on either side of the comment
## like this ##

but it only seems to work if it's at the beginning of the calculated field.

[Djmiles]

Thank you! I'd seen several examples of using one or two #, but nothing explicitly stated that it had to be at the beginning of the file. 

[marcwo · Accepted solution]

This is interesting.

It seems like, if you start the comment on the first row with at least one hashtag, you can even write multi line comments as long as the rows start with a hashtag...and you dont even have to close it.

Caluclated field also continues working. Disclaimer: tested on BigQuery datasource

[lauratilton]

FYI I just tried this (Sheets datasource) and it worked fine too. I am not sure why I've always used the double hashtag on either side! 🤷🏻‍♀️

[christina_blake]

Are there any plans to allow for comments? This double hashtag workaround only works if a formula doesn't start with a field, e.g.

This works:
## Some comments ##
SUM(field / field)

This doesn't work:
## some comments ##
field / field