哪种注释格式对于带有注释的 TypeScript 是正确的？

【问题标题】：Which comment format is correct for TypeScript with annotations?哪种注释格式对于带有注释的 TypeScript 是正确的？
【发布时间】：2019-12-08 23:44:36
【问题描述】：

我一直在寻找对带注释的代码进行注释的示例，我能找到的只是非注释代码上的 cmets 示例。任何人都可以澄清正确或批准的标准编写方式吗？

/**
 * Description.
 */
@Component({...})
class MyClass{...}

或者这会写成

@Component({...})
/**
 * Description.
 */
class MyClass{...}

【问题讨论】：

标签： javascript typescript comments jsdoc

【解决方案1】：

CompoDoc 有一个example 使用您描述的语法的第一个变体。所以，这意味着（引用他们的例子）：

/**
 * @ignore
 */
@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {}

然而，正如this issue 所示，目前没有关于如何编写 TSDoc 的固定或官方规范。

【讨论】：

Dousse 感谢您提供链接示例。非常感谢。
没问题。我还添加了一个与 TSDoc 相关的问题的链接，该问题目前尚未解决，您可能会感兴趣。