Hi Andrew,
JavaScript/TypeScript parsers have built-in support for JavaDocs, so it will display descriptions for method/ method parameters if they’re defined.
/**
Converts a level name or value to a {@link logging.Level} value.
If the name/value is not recognized, {@link logging.Level.ALL} will be returned.
@param {(number|string)} nameOrValue The log level name, or value to convert .
@return {!logging.Level} The converted level.
*/
function getLevel(nameOrValue : string | number) : number {
return 0;
getLevel(1); // this will show signature help with parameter descriptions
}
The problem for types/methods coming from .NET Framework is that we do not include these JavaDoc comments when we generate .d.ts files. One of the reason that will make these d.ts files a lot larger and most likely will affect performance of code parsing and script execution.
We do have a support for descriptions for .NET classes, but not for immediate release.
From initial investigation there seem to be these two options here - one is to put java docs in the generated .d.ts files (provided that performance impact is tolerable), another one - is to load descriptions on-demand (this is what we do for our advanced C# parsers in DescriptionHelper class - by locating .NET xml files and loading/parsing their content).
In both cases there should be xml files to start with (from memory they’re only installed with .NET SDK, not with .NET Framework itself).
Second approach so far look more promising, however SignatureHelpItems returned by TypeScript service, does not seem to contain a qualified name of the symbol to the left of the method, only names of the methods and parameters, so in order to construct a lookup key we might need to do another call to the parser to find out this qualified name.
Let me know how soon you need this feature and we work on it sooner if needed.
Kind regards,
Dmitry