Sandcastle 未在 Visual Studio 中记录 none 个库项目

Sandcastle not documenting none library projects in Visual Studio

我是 Sandcastle 的新手。我使用的版本是2018.7.8.0。我在 visual Studio 2015 年有一个解决方案,它有 2 个项目,其中一个是 class 库(在沙堡中有 XMl 和 dll 文件),另一个是通常的 C# 控制台应用程序XMl 和沙堡中的 exe 文件)。

在 Sandcastle 或 Visual Studio 中构建项目时,我只得到 index.html 文件中记录的 class 库项目。

有没有办法包含其他项目?

您知道 - XML 注释必须添加到您的代码中以记录各种类型及其成员。

此外,您必须为项目启用XML 注释文件输出。

  1. 在解决方案资源管理器中,右键单击项目和 select 属性。
  2. Select 构建 属性 页面。
  3. 在“输出”部分,选中 Xml 文档文件文本框旁边的复选框,并为 XML 文件指定一个名称。虽然不是必需的,但通常的约定是在相关程序集之后命名 XML 注释文件(除了带有 .xml 扩展名)。程序集名称可以在应用程序 属性 页面上找到。
  4. 如果您有包含多个项目的解决方案 需要记录,请对解决方案中的每个项目重复上述步骤。建议您为每个项目的 XML 评论文件起一个唯一的名称。

关于使用 Sandcastle,您会找到演练 Creating Your First Project