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中，您将只有文本，而在另一个文档块中，您可以创建更复杂的属性说明。

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

如果属性文档不存在但@param是，则可以附加文档。否则，如果存在属性文档，则它将覆盖@param。那会很好。

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

1 个答案: