使用Sandcastle帮助文件生成器(SHFB)的文档中未显示摘要 [英] Summary is not appeared in the documentation using Sandcastle Help File Builder (SHFB)

问题描述

我已使用Sandcastle来编写C#桌面Windows应用程序的文档.我正在使用Sandcastle帮助文件生成器(SHFB)，并包含* .sln或* .csproj文件来提取信息并将其作为* chm文档文件.它已编译，但无法正常工作，因为我已经添加了这样的评论

I have used Sandcastle for documentation of my C# desktop windows application. I am using Sandcastle Help File Builder (SHFB) and included *.sln or *.csproj file to extract the info and make it as a *chm documentation file. It compiled but didn''t work properly as I have already added my comments like this

/// <summary>
/// Create form to display the GUI to process the data of CPRI and XIO links in side the data grids.
/// </summary>

但它不会出现在FORM1类和其他类的documentation(chm)文件中.我已经在其他课程中以类似的方式包含了其他摘要，但也没有包含.有任何想法吗?

我不知道我在哪里缺少.....谢谢.

but it is not appear in the documentation(chm) file in FORM1 class and also in other classes. I have already included other summary in the similar manner in the other classes but it was also not include.Any idea?

I do n''t know where I am lacking.....Thank you.

推荐答案

我的猜测是您没有在自己的XML注释中启用项目设置.参见本文 [

My guess would be that you did not enable the XML comments in your project settings. See this article[^] and see if that helps you.

这篇关于使用Sandcastle帮助文件生成器(SHFB)的文档中未显示摘要的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！