Come for the products,
stay for the community

The Atlassian Community can help you and your team get more value out of Atlassian products and practices.

Atlassian Community about banner
Community Members
Community Events
Community Groups

How do you add in-line comments to code snippets?

I'm trying to comment on a code snippet, but the option is greyed out.

I can do in-line comments on text but not on the actual code snippet/block.

Thank you!

2 answers

1 accepted

0 votes
Answer accepted
Bill Bailey Community Leader Oct 12, 2020

Yes, that is expected behavior. You only options are to add comments above the code block, or actually edit the code and insert comments in the code using the code syntax.

Is this something that might be changed in the future, having the ability to do in-line comments on specific lines of code?

A bit of context:
I'm building technical documentation that requires to be reviewed and improved, having in-line comments in the code would be optimal.

Like Kellie Freeman likes this
Bill Bailey Community Leader Oct 12, 2020

Well don't hold your breath. ;-) This issue was reported under CONFSERVER-36415  in 2015, and its current status is shows as "not being considered". So it is open, but no plans to fix.

Thank you for your quick reply! Looks like I will have to find another solution for my team's needs.

So.. almost one year later, did you find a solution?

As clumsy as it may sound, I've been doing this for a while with the Excerpt macro. Drop the macro in, set it to hidden, and add whatever notes you wish for the next developer. Not the intent of the Excerpt macro, but it did solve the problem for me.

0 votes

For those who still looking for answers, I can recommend a midway solution with Markup:

It doesn't support markdown highlighting, but can create a preformatted block, which can be commented.

Suggest an answer

Log in or Sign up to answer
Community showcase
Published in Confluence

Confluence: Where work and wellness meet

Feeling overwhelmed by the demands of work and life? With a 25% increase in the prevalence of anxiety and depression worldwide during the pandemic, for most of us, it’s a resounding yes . 🙋‍♀️ ...

1,013 views 17 27
Read article

Community Events

Connect with like-minded Atlassian users at free events near you!

Find an event

Connect with like-minded Atlassian users at free events near you!

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you