TSDoc 项目教程

1. 项目目录结构及介绍

TSDoc 项目的目录结构如下：

tsdoc/
├── api-demo/
├── common/
├── eslint-plugin/
├── playground/
├── spec/
│   └── code-snippets/
├── tsdoc-config/
├── tsdoc/
├── .gitattributes
├── .gitignore
├── .prettierignore
├── .prettierrc.js
├── LICENSE
├── README.md
├── SECURITY.md
├── rush.json

目录介绍

• api-demo/: 包含代码示例，展示了如何使用 TSDoc 解析器。
• common/: 包含项目通用的工具和库。
• eslint-plugin/: 包含 ESLint 插件，用于检查 TSDoc 注释的语法。
• playground/: 包含 TSDoc Playground 的源代码，提供了一个交互式演示平台。
• spec/: 包含 TSDoc 规范的代码片段。
• tsdoc-config/: 包含 TSDoc 配置文件的加载器。
• tsdoc/: 包含 TSDoc 解析器的主要实现。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• .prettierignore: Prettier 忽略文件配置。
• .prettierrc.js: Prettier 配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• SECURITY.md: 项目安全相关信息。
• rush.json: Rush 构建工具的配置文件。

2. 项目的启动文件介绍

TSDoc 项目没有传统的“启动文件”，因为它是一个库项目，主要用于解析 TypeScript 代码中的文档注释。不过，如果你要运行 TSDoc Playground，可以参考以下步骤：

1. 进入 playground/ 目录。
2. 运行 npm install 安装依赖。
3. 运行 npm start 启动 Playground。

Playground 的入口文件是 playground/src/index.ts，它负责初始化并启动 Playground 应用。

3. 项目的配置文件介绍

.prettierrc.js

Prettier 配置文件，用于格式化代码。示例如下：

module.exports = {
  printWidth: 100,
  tabWidth: 2,
  useTabs: false,
  semi: true,
  singleQuote: true,
  trailingComma: 'all',
  bracketSpacing: true,
  arrowParens: 'always',
};

rush.json

Rush 构建工具的配置文件，用于管理多包项目。示例如下：

{
  "$schema": "https://developer.microsoft.com/json-schemas/rush/v5/rush.schema.json",
  "rushVersion": "5.34.0",
  "pnpmVersion": "5.5.12",
  "nodeSupportedVersionRange": ">=12.13.0 <13.0.0",
  "projects": [
    {
      "packageName": "@microsoft/tsdoc",
      "projectFolder": "tsdoc"
    },
    {
      "packageName": "@microsoft/tsdoc-config",
      "projectFolder": "tsdoc-config"
    },
    {
      "packageName": "eslint-plugin-tsdoc",
      "projectFolder": "eslint-plugin"
    },
    {
      "packageName": "tsdoc-playground",
      "projectFolder": "playground"
    }
  ]
}

tsdoc.json

TSDoc 配置文件，用于自定义 TSDoc 解析器的配置。示例如下：

{
  "extends": "@microsoft/tsdoc-config/tsdoc.json",
  "tagDefinitions": [
    {
      "tagName": "@customTag",
      "syntaxKind": "block"
    }
  ]
}

这个配置文件允许你定义自定义的 TSDoc 标签。

通过以上介绍，你应该对 TSDoc 项目的目录结构、启动文件和配置文件有了基本的了解。希望这些信息能帮助你更好地使用和贡献 TSDoc 项目。