How to add Comments in a JQL statement

[Stephen Miko]

I have several Filters that include a list of Epics or Stories in the issuekey.  Eg:

...... issuekey in (TST-01, TST-02 TST-03........TST-10).  

Users want a Filter that pulls several of these at a time.  The number of issuekeys for a given pull varies by user and by time.  So the users will pull out the issuekeys that don't pertain to the given requirement.  Eg ......issukey in (TST-02, TST-04, TST-06, TST-08).

I want to add Comments to the saved JQL filter to define each issuekey.  Eg:

- - TST-01 = Open Defects;  TST-02 = Open SubTasks;   TST-03 = Open Stories; etc

[Trudy Claspill · Accepted solution]

Hello @Stephen Miko 

I am unclear what you are trying to achieve. Can you try to provide more information?

A JQL statement is a set of criteria that is compared to issues in order to select matching issues. You can't add comments to a JQL statement, like you would add comments to programming code.

You can fill in a Description for the saved filter, but you can't insert explanatory comments into the JQL itself.

I don't understand what you are trying to do when you say you want to "define" an issue key? What is the problem that you are trying to solve in this case?

Are you trying to select issues based on more generalized criteria; i.e "Open Defects", rather than specifying individual issue keys?

[Stephen Miko]

You answered my question with: 

"You can't add comments to a JQL statement, like you would add comments to programming code."

I will keep it in the filter Description.  Thanks for your prompt response.

[Trudy Claspill]

You're welcome.

If your question has been adequately addressed please consider clicking the Accept Answer button.

[Christopher Hogan]

It is really awkward, but you could add nonsense elements to the filter, like:
     project = MyProject and
     summary !~ "XXX This is where I check for issue type XXX" and
     type = bug and ...
Is that too weird?

[Kim Hudson]

I like this!  Thank you!

[Matt Parks]

If you're looking to add information into the filter that won't be part of the query but just provides additional information about what each part of the query means, there is not a way to do that.

The closest thing you could do would be to have that information in the filter name, but I think that would be very cumbersome.

[Martin Flury]

You nailed it.
This is the exact reason why I was also looking for the option to add commends to a JQL filter.
Some filters are very complex and it would be very helpful if you could add some comments in a filter.
Separating JQL in different lines mad it also a bit more structurable, but still not what I was looking for.