New Line on Javascript Summary / Documentation

Question

I'm using Visual Studio Enterprise 2015 & Resharper 10 for my javascript project. I'm writing documentation for my javascript functions. These documentation also helps me with intellisense when I'm writing code.

    /**
     * @description Get element(s) by a query. 
     * An ex: 
     * find all paragraphs with the class "summary" in the article with ID "first"
     * "article#first p.summary"
     * @param {String} query
    */
    getByQuery: function(query) {
        return exampleFunction(query);
    }

But I can't find a way for creating new lines in javascript summary/documentation.

Please look at this picture, you will understand what I mean;

I tried;

<br>
<br/>
@newline
\n
<para>
</para>
@example

Only add a new empty line if you want separate line in comment. — Doan Thai, Jan 05 '22 at 08:20

ReaperSoon · Answer 1 · 2016-10-05T12:22:40.053

-1

try using < br > for your new line.

My line one<br>
My line two

edit:

Sorry the < br > is for eclipse documentation. For Visual Studio try < para >

<para>My line one</para>
<para>My line two</para>

edited Oct 05 '16 at 12:22

answered Oct 05 '16 at 08:16

ReaperSoon

765
7
23

1

Hello, thanks for your answer. But it didn't work. Now text comes like; "Get element(s) by a query. An ex:
find all..." – Lost_In_Library Oct 05 '16 at 08:34
I just updated my answer, in Visual Studio you need to use to have a new line. The answer
is used in Eclipse – ReaperSoon Oct 05 '16 at 08:49
1

Sorry, second example is not working too. – Lost_In_Library Oct 05 '16 at 11:04
Yep sorry , edited again – ReaperSoon Oct 05 '16 at 12:24
1

Hello, thanks for help but it's not working. I think your solution is valid but not in my case. Because I'm using JsDoc comment standarts, not xml-comment standarts. – Lost_In_Library Oct 05 '16 at 12:39
Ok I understand, did you tried this ? http://stackoverflow.com/a/29284639/2518101 – ReaperSoon Oct 05 '16 at 13:17
I checked, not working on this ide I think ( Visual Studio ). I also check my resharper configuration and visual studio's options. Everything seems ok. But no luck for solution. – Lost_In_Library Oct 05 '16 at 13:45

New Line on Javascript Summary / Documentation

1 Answers1