SourceBrowser 项目使用教程

1、项目介绍

SourceBrowser 是一个开源项目，用于生成静态 HTML 网站，以便浏览 C#、VB、MSBuild 和 TypeScript 源代码。它通过 Roslyn 分析源代码，生成超链接的静态 HTML 文件，支持多种代码浏览功能，如“转到定义”、“查找所有引用”等。SourceBrowser 主要用于生成和托管自己的源代码浏览网站，支持在 ASP.NET Core 网站上进行托管。

2、项目快速启动

2.1 环境准备

• 安装 Visual Studio 2019 或更高版本。
• 安装 .NET Core SDK。

2.2 克隆项目

git clone https://github.com/KirillOsenkov/SourceBrowser.git
cd SourceBrowser

2.3 构建项目

Build.cmd

2.4 生成和运行测试网站

GenerateTestSite.cmd
RunTestSite.cmd

2.5 在 Visual Studio 中运行

1. 打开 SourceBrowser.sln。
2. 将 HtmlGenerator 项目设置为启动项目。
3. 按 F5 运行，预配置为生成 TestCode\TestSolution.sln 的网站。

3、应用案例和最佳实践

3.1 应用案例

• 内部代码库浏览：公司可以使用 SourceBrowser 生成内部代码库的静态 HTML 网站，方便开发人员浏览和查找代码。
• 开源项目文档：开源项目可以利用 SourceBrowser 生成项目文档，提供代码浏览功能，增强用户体验。

3.2 最佳实践

• 定期更新：定期重新生成网站，确保代码浏览功能与最新代码同步。
• 自定义部署：根据需求自定义部署脚本，确保网站的快速更新和部署。

4、典型生态项目

• Roslyn：SourceBrowser 使用 Roslyn 进行源代码分析，生成静态 HTML 文件。
• ASP.NET Core：SourceBrowser 需要 ASP.NET Core 网站进行托管，支持搜索功能。
• NuGet：SourceBrowser 提供了 NuGet 包，方便集成到其他项目中。

通过以上步骤，您可以快速启动并使用 SourceBrowser 项目，生成和托管自己的源代码浏览网站。