使用功能时如何编辑显示的说明?

时间:2019-07-05 05:17:26

标签: javascript node.js visual-studio-code

使用公共存储库中的函数时,它们将显示变量名称,后跟变量类型,如下所示。

Repo's Function Description

我如何使自己的函数显示为这样,因为它当前显示为变量名,后跟变量类型“ any”,如下所示。

My Function Description

2 个答案:

答案 0 :(得分:0)

以下是您可以做什么的一个示例-

UPDATE Table1
SET STATUS = 'C' 
WHERE Col1 IN (SELECT Col2 FROM Table1)

答案 1 :(得分:0)

如上所述,我认为编辑器将使用每个函数上方的注释中的@params来定义函数的参数,前提是您使用此处可以找到的Javascript文档标准:

https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/javascript/

/**
 * Summary. (use period)
 *
 * Description. (use period)
 *
 * @since      x.x.x
 * @deprecated x.x.x Use new_function_name() instead.
 * @access     private
 *
 * @class
 * @augments parent
 * @mixes    mixin
 * 
 * @alias    realName
 * @memberof namespace
 *
 * @see  Function/class relied on
 * @link URL
 * @global
 *
 * @fires   eventName
 * @fires   className#eventName
 * @listens event:eventName
 * @listens className~event:eventName
 *
 * @param {type}   var           Description.
 * @param {type}   [var]         Description of optional variable.
 * @param {type}   [var=default] Description of optional variable with default variable.
 * @param {Object} objectVar     Description.
 * @param {type}   objectVar.key Description of a key in the objectVar parameter.
 * 
 * @return {type} Description.
 */