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

【问题标题】：JSDoc for parameter property declarations doesn't apply to the properties用于参数属性声明的 JSDoc 不适用于属性
【发布时间】：2014-01-11 03:52:01
【问题描述】：

如果我用这样的参数属性声明创建一个构造函数：

constructor(public someProperty) { }

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

/** @param someProperty Example property documentation */

并让此文档同时适用于参数和相应的属性。

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

如何在不明确声明属性的情况下实现这一点？

【问题讨论】：

标签： visual-studio comments typescript jsdoc

【解决方案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。那就太好了。

【讨论】：