Пакет mysql написан на чистом JS, однако включает документацию. Эта документация стандартизирована как JSDo c. VSCode имеет встроенную поддержку для чтения этой документации и отображения ее пользователю. (Примечание: он не поддерживает все теги JSDo c)
Пример из mysql/index.js
. ( source )
/**
* Create a new Connection instance.
* @param {object|string} config Configuration or connection string for new MySQL connection
* @return {Connection} A new MySQL connection
* @public
*/
exports.createConnection = function createConnection(config) {
var Connection = loadClass('Connection');
var ConnectionConfig = loadClass('ConnectionConfig');
return new Connection({config: new ConnectionConfig(config)});
};
Тег @param
указывает, какие типы config
могут получать. {object|string}
означает, что это может быть либо объект, либо строка.