使用Sandcastle帮助文件生成器(SHFB)的文档中未显示摘要

编程入门 行业动态 更新时间:2024-10-28 20:28:22
本文介绍了使用Sandcastle帮助文件生成器(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)的文档中未显示摘要

本文发布于:2023-11-06 04:23:41,感谢您对本站的认可!
本文链接:https://www.elefans.com/category/jswz/34/1562707.html
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系,我们将在24小时内删除。
本文标签:生成器   帮助文件   中未   摘要   文档

发布评论

评论列表 (有 0 条评论)
草根站长

>www.elefans.com

编程频道|电子爱好者 - 技术资讯及电子产品介绍!