Add JSDOC @module support for intellisense.

Search Terms

Intellisense jsdoc support for modules

Suggestion

When adding /** @module moduleName Module Description. */ to a module, then doing this:

import * as myName from "./moduleName";

I think it makes sense, when importing the whole namespace, to include the jsdoc @module comment.

I also think that when pressing Ctrl+Space for code completion on "./" (to get a list of modules) should also show the module documentation.

Use Cases

Better support for module documentation. I’m developing some module libraries and it would be great to give end users a good experience with better intellisense documentation.

Examples

aModule.ts

`/** @module aModule Does something awesome. */`

app.ts

import * as aModule from "./aModule";
// (moduleName should both have the doc details)
// ("./{*.*}" - all files in code completion should show the documentation as well)

Checklist

My suggestion meets these guidelines:

• This wouldn’t be a breaking change in existing TypeScript/JavaScript code
• This wouldn’t change the runtime behavior of existing JavaScript code
• This could be implemented without emitting different JS based on the types of the expressions
• This isn’t a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
• This feature would agree with the rest of TypeScript’s Design Goals.

[borekb]

Also, quite annoyingly, the module doc comment is shown for the first member:

Playground link

[tysonrm]

connect-stream.js

    /**
     * @param {import('stream').Readable} in 
     * @param {import('stream').Writable} out
     */
    export async function connectStream(in, out) {
      in.pipe(out)
    }

detect-fighting.js

    /**
     * @param {import('stream').Readable} lidar 
     * @param {import('stream').Writable}  infer
     * @param {import('./connect-stream').connectStream} cb
     */
    async function detectFighting(lidar, infer, cb) {
      cb ( 
          lidar.getReadableStream('camera10'), 
          infer.getWritableStream('fighting')
       )
    }

The jsdoc of the 3rd param in detect-fighting.js is not supported. You can write @callback but, again, the point is to avoid having to do that and having to keep it in sync with the actual function.