前端 - 请问下，typedoc使用时候，函数上的注释，还是指的typedoc自动生成的呢？

Question

在使用TypeDoc的时候：
看到有说明

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

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

Answer 1

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

Answer 2

在使用TypeDoc时，注释（特别是函数上的注释，包括@param、@returns等JSDoc标签）是开发者在编写代码时就需要写好的，而不是TypeDoc自动生成的。

TypeDoc通过解析源代码中的JSDoc注释来生成文档。这些注释遵循JSDoc的规范，允许开发者在代码中为函数、类、变量等添加详细的描述、参数说明、返回值类型等信息。当TypeDoc运行时，它会读取这些注释，并基于源代码和注释的内容生成易于阅读的HTML文档。

因此，为了得到准确、有用的文档，开发者需要在编写代码时就注意添加适当的JSDoc注释。这些注释不仅有助于TypeDoc生成文档，也能在IDE中提供代码补全、类型检查等辅助功能，提升开发效率。

示例：

/**
 * 计算两个数的和
 * @param a 第一个加数
 * @param b 第二个加数
 * @returns 返回两个数的和
 */
function add(a: number, b: number): number {
  return a + b;
}

在上述示例中，@param用于描述函数参数，@returns用于描述函数返回值。这些注释都是开发者手动编写的，TypeDoc会根据这些注释生成相应的文档。