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正确？

1 个答案: