Sandcastle Help File Builder —— [Missing ＜summary＞ documentation for “N:“]

最新推荐文章于 2024-05-12 09:46:00 发布
最新推荐文章于 2024-05-12 09:46:00 发布
阅读量415 收藏 1
点赞数
分类专栏： 软件使用 文章标签： C#
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/zhelijun/article/details/108362352
版权

英文好的看这里

解决办法：
在这里插入图片描述

在SHFB Gui中，去到Project Properties——Summaries——Namespace Summaries——None

在弹出的窗口中等待你的namespace出现
4. 勾选左边命名空间
5. 等待右边出现你的命名空间后选中
6. 在下面的summary编辑窗口编辑你的summary
7. 最后点击close
8. 然后再次编译生成

文档里面成功生成namespace的summary！

Wo看见常威在打来福
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Sandcastle+SandcastleHelpFileBuilder
11-24
微软的Sandcastle和SandcastleHelpFileBuilder，可以根据注释自动生成帮助文档，只要是注释写得好，文档生成的就漂亮
sandcastle help file builder v2017.5.15.0完整版
10-14
一般不用安装VS 的 SHFB插件。 SHFBInstaller_v2017.5.15.0，免费版。 含： SHFBVisualStudioPackage_VS2013.vsix SHFBVisualStudioPackage_VS2015AndLater.vsix 按安装提示，逐个安装即可。
Sandcastle Help File Builder[Missing <summary> documentation for ""]
静哥亻门
08-02 1284
接口类文档的一般形式        第一：口头传递技术文档，也就是没有实质的文档资料，口头说明一下即可，这种情况局限于沟通起来非常方便的开发团队中，例如就坐在一个办公间等等。        第二：以文本形式，把如何使用的技术点记录下来，这个方法有什么用，那个属性是做什么的等等，这种方式无疑是表述最清楚的，单独的文档中你甚至可以用图的方式教导使用者，但缺点就是维护起来相当麻烦，而且费时。
推荐开源项目：Sandcastle Help File Builder
最新发布
gitblog_00079的博客
05-12 334
推荐开源项目：Sandcastle Help File Builder 项目地址:https://gitcode.com/EWSoftware/SHFB 项目介绍 欢迎来到Sandcastle Help File Builder项目的世界！这是一个强大的工具集合，旨在帮助开发者创建专业且完整的帮助文件，用于托管的类库API文档，包括概念性和API参考主题。项目由两部分组成：Sandcastle工具...
WPF Sandcastle Help File Builder Documentation（c# summary注释文档）基本使用
KING_QAQ的博客
01-10 167
Sandcastle Help File Builder Documentation（c# summary注释文档）基本使用
Sandcastle Help File Builder
dhka8040652的博客
07-09 265
最近我和其它部门配合,给他们提供一个外部服务,既然是提供给别人用的,当然需要告诉别人怎么来用你的服务,这也就是我们常说的技术文档。各组之间传递技术文档的方式有很多种。这里我知道的大概有以下几种： 第一：口头传递技术文档，也就是没有实质的文档资料，口头说明一下即可，这种情况局限于沟通起来非常方便的开发团队中，例如就坐在一个办公间等等。 第二：以...
SandcastleHelpFileBuilder2017有一个25页的使用说明文档
04-19
Sandcastle（包含一个25页的使用文档） 这个是c#类库方法根据注释生成帮助文档的工具，我们经常会遇到把DLL或者API提供给别人调用的情况，通过在方法中添加注释，然后再用Sandcastle 来自动生成文档给调用者，如下 ...
Sandcastle和SandcastleHelpFileBuilder
11-29
例如，类、方法、属性等元素都可以有对应的注释标签，如`<summary>`、`<param>`、`<returns>`等，这些标签提供了关于代码元素的详细描述。当Sandcastle处理这些注释时，它会将它们整理成合适的文档结构，包括类的...
SandCastle Help File Builder V1.9.7.0
04-19
《使用SandCastle Help File Builder V1.9.7.0为C#程序创建专业帮助文件》 在软件开发过程中，为程序提供清晰易懂的帮助文件是至关重要的，它能够为用户指引操作步骤，解答疑惑，提升用户体验。SandCastle Help ...
如何制作dll库的API文档，自动生成微软风格的chm文件 Sandcastle Help File Builder 使用方法...
weixin_30379911的博客
07-14 302
当你开发了一个库的时候，就需要给库开发一个api文档，微软提供了一个C#库的自动生成工具。我在使用的过程中记录了相关的信息，以供大家学习和查阅，如有不正之处，欢迎指出。 首先先下载一个软件，下载地址在github上：https://github.com/EWSoftware/SHFB/releases 下载最新的版本即可。到本地后开始安装 先安装上面的msi文件，安装好以...
用Sandcastle和Help Integration Wizard把文档集成到Visual Studio中
09-09 828
用Sandcastle和Help Integration Wizard把文档集成到Visual Studio by Freesc Huanghttp://fox23.cnblogs.com1.准备在正式开始工作之前，请确保您正确的安装以下软件1.1  Visual Studio 2005 SP1 SDK (VS2005 SDK 4.0) http://
命名空间怎么添加说明
weixin_30662011的博客
07-12 138
在做帮助文件时，发现NameSpace注释不起作用，找了一下资料，最后发现在Scandcastle Help File Builder上面专门有一项功能是来设置命名空间的summary的。 NamespaceSummaries中设置 写下来，希望后面的人用到：） 转载于:https://www.cnblogs.com/flysent/archive/2011/07/12/2104246.html...
SandcastleHelpFileBuilder文档生成
cxzhq2002的杂记
12-25 990
 使用 Sandcastle Help File Builder 制作 VS.NET 的 HELP 文件 以前笔者都是使用 NDoc 在制作 VS.NET 的 HELP 文件，它是相当好用且速度快的 HELP 产生器；不过 NDoc 在 1.3.1 版后，NDoc 的作者 Kevin Downs 就不再进行 NDoc Open Soruce 的开发。笔者之前有自行修改 NDoc 的 S
Sandcastle入门：创建C#帮助文档
greatwallmy的专栏
04-02 8898
  Sandcastle入门：创建C#帮助文档　　今天学到了一个东西：利用vs2005生成的dll/xml来生成帮助文档。完成这个伟大任务的是Sandcastle，微软推出的类库文档编译工具。在开始这篇笔记之前，我想先感谢我文后提及的七篇关于Sandcastle的文章。是它们出色的阐述使得我能够整理出这篇笔记，之前我从未接触过。对于那七篇文章，我努力寻找它们的源出处链接，然而网
Sandcastle Help File Builder 生成NET帮助文档
weixin_33700350的博客
12-30 205
Sandcastle是微软提供的一个根据XML注释和DLL文件生成帮助文件的工具，目前是在CodePlex上的一个开源项目，可以去这里下载：Sandcastle Sandcastle生成的输出结果具有以下特点： Ø类似于MSDN布局的界面。 Ø自动生成索引项、内容项目表、主题块和页面布局，提高一致性和熟悉程度。 Ø自动生成语法宣称部...
.Net使用SandCastle生成API文档
chengzhf的专栏
06-05 405
.NET下生成api文档的一个好办法
使用 Sandcastle Help File Builder 制作文档
aynbxl8574的博客
08-17 223
1.下载安装Sandcastle 程序。 http://download-codeplex.sec.s-msft.com/Download/Release?ProjectName=shfb&DownloadId=1408995&FileTime=130655702941330000&Build=21029 2.在程序中使用批注将代码注释说明清楚...
c#中/// <summary>什么意思
06-01
在C#中，`/// <summary>`是一种XML文档注释，用于为类、方法、属性、字段等成员添加注释。它是一种特殊的注释格式，可以让开发者在代码中添加一些额外的信息，并且这些信息可以被工具解析和显示出来，包括Intellisense、文档生成器等。 `/// <summary>`通常用于为成员添加简短的描述，它应该放在成员的前面，如下所示： ```csharp /// <summary> /// This is a summary of the MyClass class. /// </summary> public class MyClass { // class members } ``` 在Visual Studio中，您可以通过将光标放在某个成员上并按下F12键，来查看其注释摘要。此外，您还可以使用特定的文档生成器（如Sandcastle）来生成代码的API文档，以帮助其他开发者更好地理解和使用您的代码。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值