请问下,typedoc使用时候,函数上的注释,还是指的typedoc自动生成的呢?

作者站长头像
站长
· 阅读数 9

在使用TypeDoc的时候:看到有说明请问下,typedoc使用时候,函数上的注释,还是指的typedoc自动生成的呢?

这里,注释的时候有这些写的很规整的参数,比如:@param 等。

请问下,这些是应该开发者在编写代码的时候就写好,还是指的typedoc自动生成的呢? 因为typedoc是用于生成HTML文档的,这个应该是开发者在编码的时候就写好是吗。

回复
1个回答
avatar
test
2024-09-07

是的这是开发者自己写的,就跟 TypeScript 中的类型注释一样。可以参考 JSDoc

回复
likes
适合作为回答的
  • 经过验证的有效解决办法
  • 自己的经验指引,对解决问题有帮助
  • 遵循 Markdown 语法排版,代码语义正确
不该作为回答的
  • 询问内容细节或回复楼层
  • 与题目无关的内容
  • “赞”“顶”“同问”“看手册”“解决了没”等毫无意义的内容