我一直在寻找一个注释代码的例子,我能找到的只是注释非注释代码的例子。
有谁能澄清正确的或被认可的标准写作方式吗?
/**
* Description.
*/
@Component({...})
class MyClass{...}
或者这会被写成
@Component({...})
/**
* Description.
*/
class MyClass{...}
最佳答案
compodoc使用您描述的语法的第一个变体有一个example。所以,这意味着(引用他们的例子):
/**
* @ignore
*/
@Component({
selector: 'app-root',
templateUrl: './app.component.html',
styleUrls: ['./app.component.css']
})
export class AppComponent {}
然而,正如this issue所示,目前还没有关于如何编写tsdoc的固定或官方规范。