# How to mention an issue ID in Dokka comments

**URL:** <https://discuss.kotlinlang.org/t/how-to-mention-an-issue-id-in-dokka-comments/10905>\
**Category:** Support\
**Created:** [December 25, 2018, 7:48am UTC](https://discuss.kotlinlang.org/t/how-to-mention-an-issue-id-in-dokka-comments/10905 "2018-12-25T07:48:44Z")\
**Posts on this page:** 3\
**Page:** 1

<div class="post-metadata">

**Author:** ![DKorchuganov](https://sea1.discourse-cdn.com/flex019/user_avatar/discuss.kotlinlang.org/dkorchuganov/32/5779_2.png) [@DKorchuganov](https://discuss.kotlinlang.org/u/DKorchuganov)\
**Post date:** [December 25, 2018, 7:48am UTC](https://discuss.kotlinlang.org/t/how-to-mention-an-issue-id-in-dokka-comments/10905/1 "2018-12-25T07:48:44Z")

</div>

I didn’t find any block tag in Dokka to reference a JIRA/Github/etc ticket. Any plans to add it in future? What is the current best practice?

I prefer to have a cross-reference to a ticket with the original requirements in class/function comments; it gives a better understanding of the code

---

<div class="post-metadata">

**Author:** ![ilya.gorbunov](https://sea1.discourse-cdn.com/flex019/user_avatar/discuss.kotlinlang.org/ilya.gorbunov/32/1645_2.png) [@ilya.gorbunov](https://discuss.kotlinlang.org/u/ilya.gorbunov)\
**Post date:** [December 26, 2018, 6:24pm UTC](https://discuss.kotlinlang.org/t/how-to-mention-an-issue-id-in-dokka-comments/10905/2 "2018-12-26T18:24:18Z")

</div>

If a bug tracking system provides urls for individual issues, you can just use that url as a link in markdown doc comment with the syntax `[link title](url)`, e.g. as following:

```auto
/**
 * Represents a range of values (for example, numbers or characters).
 * See the [Ranges documentation](http://kotlinlang.org/docs/reference/ranges.html) for more information.
 */
public interface ClosedRange<T: Comparable<T>> {
...

```

---

<div class="post-metadata">

**Author:** ![DKorchuganov](https://sea1.discourse-cdn.com/flex019/user_avatar/discuss.kotlinlang.org/dkorchuganov/32/5779_2.png) [@DKorchuganov](https://discuss.kotlinlang.org/u/DKorchuganov)\
**Post date:** [December 26, 2018, 7:17pm UTC](https://discuss.kotlinlang.org/t/how-to-mention-an-issue-id-in-dokka-comments/10905/3 "2018-12-26T19:17:56Z")

</div>

OK, thanks. Actually, even JavaDoc doesn’t have a special tag to reference a ticket, seems to be an over-complicated feature-request for a doc-generation tool…