trivago/melody

Missing IntelliSense on VS Code.. Add Type Definitions and JS Doc

开放

#7 创建于 2017年11月24日

 (2 条评论) (0 个反应) (0 位负责人)JavaScript (37 个派生)auto 404
good first issue

仓库指标

星标
 (216 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

IntelliSense for melody is really hard to read in Visual Studio Code. VS Code generates this from JS Doc or Type Definition files.

Sadly, there are only very few places in melody that have JS Doc comments. For some reason, a lot of functions have a license header instead of actual documentation. Why do you write license header for every function instead of just once per file?

Those few parts that have JS Doc don't seem to show in IntelliSense either.. I guess VS Code can't make it work for node-modules. But Type Definition files do work and they even work for JavaScript, so your users don't need to use TypeScript to benefit from this.

A website with tutorials is of course a nice starting point, but when I code, I usually use IntelliSense instead of visiting a website.

贡献者指南