@remarks

标记类型：块标记

TSDoc 标准化： 核心

API 项的主要文档分为一个简短的“摘要”部分，可选地后跟一个更详细的“备注”部分。在文档网站上，索引页（例如显示类的成员）将仅显示简短的摘要，而详细信息页（例如描述单个成员）将显示摘要后跟备注。@remarks 块标记结束摘要部分，并开始文档注释的备注部分。

注意：此设计不同于 JSDoc 的方法，该方法使用一个可选的 @summary 标记来提供对完整文档的简要重述。我们尝试过这种方法，但发现一篇写得很好的文章已经在其第一句或两句中包含了“摘要”。

使用示例

/**
 * Represents an employee.
 *
 * @public
 */
export class Employee {
  /**
   * The employee's first name.
   *
   * @remarks
   * The first name may contain Unicode characters.
   */
  public firstName: string;

  /**
   * The employee's last name.
   *
   * @remarks
   * The last name may contain Unicode characters.
   */
  public lastName: string;

  /**
   * The employee's full name.
   *
   * @remarks
   * Returns the first name followed by the last name.
   */
  public getFullName(): string {
    return `${this.firstName} ${this.lastName}`;
  }
}

该类的索引页可能以类似于这样的表格显示摘要

属性
属性修饰符类型描述
firstName 字符串 员工的姓氏。
lastName 字符串 员工的姓氏。
方法
方法修饰符描述
getFullName() 员工的全名。

属性	修饰符	类型	描述
firstName		`字符串`	员工的姓氏。
lastName		`字符串`	员工的姓氏。

方法	修饰符	描述
getFullName()		员工的全名。

而 getFullName() 的详细信息页将显示摘要后跟备注

Employee.getFullName() 方法
员工的全名。
签名
getFullName(): string;
返回：字符串
备注
返回姓氏后跟名。

另请参阅​

另请参阅