visual-studio - 参数属性声明的 JSDoc 不适用于属性

Question

如果我创建一个带有如下参数属性声明的构造函数:

constructor(public someProperty) { }

我希望能够将 JSDoc 应用于 someProperty:

/** @param someProperty Example property documentation */

并将此文档应用于参数和相应的属性。

但是，在 Visual Studio 中，文档似乎只适用于参数。我不知道这是否是 Visual Studio 集成或语言规范中的缺陷。是哪个？或者两者都不是？

如何在不显式声明属性的情况下实现这一目标？

Answer 1

你需要这样做。

class Foo
{
    /** @param someProperty Example property documentation */
    constructor(
        /**
        * The documentation needs to go here
        */
        public someProperty
    )
    {
    }
}


new Foo("").someProperty;

@param 和属性可以是相同的文档，这是可以理解的，但不一定。

在 @param 中，您将只有文本，而在其他文档 block 中，您可以创建更复杂的属性说明。

但是，如果您认为它可能是一项功能，您可以 suggest it here .

如果属性文档不存在但 @param 存在，它可以附加文档。否则，如果属性文档存在，那么它将覆盖 @param。那就太好了。