我正在尝试为这样的模块函数编写文档:
/**
* Usage:
*
* ```
* @NgModule({
* imports: [
* BrowserModule,
* ...,
* ThisModule.forRoot({
* name: 'Name',
* version: '1.0',
* ],
* }),
* ```
*
* @param config Service configuration parameters
*/
public static forRoot(config: SVConfig) {
问题在于@NgModule
。我尝试过:
* ```
* @NgModule
似乎 html 实体在代码之外工作得很好(```),但在代码块内却不行(它做了一些奇怪的事情,比如制作NgModule
以粗体和新行显示)
也尝试过\@
, {@literal @}
, \u0064
, @@
没有成功。
我发现的最友好的是(@)NgModule
.
请问有什么建议吗?
我很幸运在 unicode 空间中使用了替代 @ 符号:U+FF20 (@) https://www.compart.com/en/unicode/U+FF20。它使文档看起来正确,但不幸的是,如果有人复制/粘贴代码块,则该文档将不起作用。至少从 2012 年开始,这似乎就是一个悬而未决的问题,所以我不会屏息以求更好的解决方案。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)