live documenter

现场记录员

不要让注释隐藏在源代码中！阅读、搜索并使用 Live Documenter 发布它。 .NET 文档变得简单。

Live Documenter 是一套应用程序和库，支持从 .NET 代码和 xml 注释文件实时查看和自动生成文档。从我们的主页了解 Live Documenter 是什么并下载最新版本。

查看实时且最新的文档！

创建漂亮的静态文档。

或者使用 API 库集成到您自己的项目中。

---

介绍

Live Documenter 是一个桌面应用程序、控制台实用程序和 API 库，旨在使您的 .NET 代码和注释更具可读性和可用性。让它们摆脱源代码中 xml 的限制，充分利用它们！

首先下载最新版本并阅读快速入门指南。

桌面应用程序

桌面应用程序允许打开 Visual Studio 项目、解决方案或库，并从实时 XML 注释文件中为其生成文档。如果对代码库进行更改，这些更改将在重新构建项目时反映在应用程序中。

它还提供了一个用于导出文档、阅读和打印的良好界面。

控制台应用程序

导出器应用程序对于将文档生成集成到现有流程中非常有用；例如您的构建脚本或创建临时文档。

API库

可供项目引用以在运行时自动生成文档的 DLL。 API 的详细信息以及如何使用它可以在文档中找到。

安装

目前，这仅适用于 Windows，正在努力转移到 netstandard 并使除桌面应用程序之外的所有内容在 .NET Core 上跨平台。

提供了最新版本的 zip 文件。要安装，请下载文件，解压缩并从目录中执行。

构建最新版本

要求

• .NET 核心 SDK 3.1

最新代码已在 Visual Studio 2019 中运行，其中几个项目已转移到 netstandard 库并使用最新的 csproj 文件格式。

如果从源代码构建有任何问题，请告诉我，以便我可以解决它们。

帮助项目

感谢所有帮助。有一个始终可以改进的相关文档站点。

如果您想参与该项目，请查看当前的问题。记下您的兴趣，获取最新版本，并在准备合并更改时创建拉取请求。

此外，简单地通过 GitHub 问题提供反馈有助于确保项目变得更加稳定并不断得到增强。