哪种注释格式适用于带有注释的 TypeScript？

Question

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

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

或者这会写成

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

Answer 1

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

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

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

哪种注释格式适用于带有注释的 TypeScript？

Which comment format is correct for TypeScript with annotations?

javascript

typescript

comments

jsdoc