# /\*\* for commenting vs /\*

**URL:** <https://forums.unrealengine.com/t/for-commenting-vs/342463>\
**Category:** Programming & Scripting\
**Tags:** unreal-engine\
**Created:** [December 26, 2015, 7:15pm UTC](https://forums.unrealengine.com/t/for-commenting-vs/342463 "2015-12-26T19:15:34Z")\
**Posts on this page:** 2\
**Page:** 1

<div class="post-metadata">

**Author:** ![SrGeneroso](https://d1ap1mz92jnks1.cloudfront.net/user_avatar/forums.unrealengine.com/srgeneroso/32/752429_2.png) [@SrGeneroso](https://forums.unrealengine.com/u/SrGeneroso)\
**Post date:** [December 26, 2015, 7:15pm UTC](https://forums.unrealengine.com/t/for-commenting-vs/342463/1 "2015-12-26T19:15:34Z")

</div>

Hi, I was wondering why comments in UE4 example projects are in the format /\*\*

Why dobule asterisk? It works with just one, It’s a common practice?

> **[Comments (C++)](https://docs.microsoft.com/en-us/cpp/cpp/comments-cpp?redirectedfrom=MSDN&view=msvc-170)**
>
> Learn more about: Comments (C++)

Also, for multiline comments they used asterisk in every line.

What about that?

---

<div class="post-metadata">

**Author:** ![anonymous\_user\_a0dfe1c61](https://d3kjluh73b9h9o.cloudfront.net/original/4X/2/8/5/28502927f1d97ba1051b3b47ccfe17233bf41ef0.png) [@anonymous\_user\_a0dfe1c61](https://forums.unrealengine.com/u/anonymous_user_a0dfe1c61)\
**Post date:** [December 28, 2015, 11:54am UTC](https://forums.unrealengine.com/t/for-commenting-vs/342463/2 "2015-12-28T11:54:15Z")

</div>

Most IDE’s will view the double asterisk as a documentation comment. Here is a screenshot of an example in Xcode

 ![72051-untitled.png](https://d3kjluh73b9h9o.cloudfront.net/original/4X/3/4/0/3400bb54c9d71b1130df6e5cad5d9a688f676c73.png)

The asterisk on the following lines are just a convention, eye candy.

```
/** Calculates something
 * @Param A A number
 * @Return 0
 */
int doSomething(float A);

```

is no different from

```
/** Calculates something
    @Param A A number
    @Return 0
 */
int doSomething(float A);

```

**Edit:**  
Please note that UE4 has a header parser that reads theses comments, and can display them in the editor, primarily as tooltips.
