有用过Sandcastle的吗？

hxwangcong 2011-02-19 11:40:24

如果要求只给项目中的一部分类做帮助文档，应该怎么弄？

...全文

76 5 打赏收藏转发到动态举报

写回复

5 条回复

切换为时间正序

请发表友善的回复…

发表回复

子夜__ 2011-02-19

打赏
举报

回复

API中有>>可以选择程序集中的某个命名空间生成文档，而不是默认的整个程序集

2.打开我们已经安装好的Sandcastle Help File Builder并对它进行设置
　　>>点击Add按钮，选中项目生成的exe,dll,xml文件
　　>>保存该项目后点击Namespaces按钮，选中想要生成帮助文档的Namespace
　　>>设定Dependencies选项，把项目中所引用到的dll文件加载进去
　　>>设置HtmlHelp1xCompilerPath为HTML Help Workshop的安装路径，
　　>>设置SandcastlePath为Sandcastle的安装路径

在这一步你就可以选择的啊

hxwangcong 2011-02-19

打赏
举报

回复

谢谢楼上的两位

我的问题是，如何给一个项目里的 一部分类 生成帮助文档

sandcastle是用反射的方法，为程序集里所有类生成文档，但是我的项目里有些类我不想让它在帮助文档里被看到

wuyq11 2011-02-19

打赏
举报

回复

sandcastle.codeplex.com
http://www.cnblogs.com/netatomy/archive/2008/01/24/1050769.html

dalmeeme 2011-02-19

打赏
举报

回复

我用的是NDOC 1.3 For .NET 2.0，推荐你这个，很好用。一个cs文件里放一个class，csc命令产生文档csc /target:library /doc:OleDbData.xml OleDbData.cs
再将OleDbData.dll和xml加入，NDoc就可以了。你可以参考一下。。。

hxwangcong 2011-02-19

打赏
举报

回复

哎，怎么沉了

.Net十大必备工具 1. Snippet Compiler Snippet Compiler 是一个基于 Windows 的应用程序，可以通过它来编写、编译和运行代码。如果具有较小的代码段，并且不希望为其创建完整的Visual Studio .NET项目（及伴随该项目的所有文件），该工具将很有用。 2. Microsoft Source Analysis for C#（StyleCop）微软内部的静态代码检查和代码强制格式美化工具StyleCop的4.2版本Microsoft Source Analysis for C# 。 SourceAnalysis 不是代码格式化工具，而是代码规范检查工具，它不仅检查代码格式，而是编码规范。 3. GhostDoc GhostDoc是Visual Studio的免费插件，可以编写XML格式的注释文档。C#中XML格式的文档注释好处：Visual Studio会显示这些注释内容，还有比如NDoc或微软的文档工具也可以用这些注释生成有良好外观的帮助文件。 4. Sandcastle Sandcastle。这是一个管理类库的文档编译器。它还可通过反射处理汇编源代码，并在代码中使用XML注释生成MSDN形式的文档，这种文档比难以解读的XML更易于理解。 5. Nunit NUnit是一个.NET上的单元测试框架。NUnit 1.x主要是移植JUnit 3.8。从2.0版本开始，NUnit进行了重写和重新设计，使用Attributes代替特定的方法和相应的基类。 6. MyGeneration MyGeneration是一个功能很强大的代码生成工具。通过编写各种类型脚本（C#,VB.Net,JScript,VBScript）的模板，通过数据库的表内容，生成你需要的各种代码。可以用它来生成ORM的实体类，存储过程，SQL语句等。 7. Reflector for .NET Reflector for .NET是一个面向 Microsoft .NET Framework 的免费类浏览器、分析器和DLL反编译器。 8. The Regulator the regulator是很有特色的工具，能使生成和测试正则表达式变得容易。它们在.NET 框架中受到支持。 9. LINQPad LINQ是Language Integrated Query的简称，是集成在.NET编程语言的特性,是编程语言的一个组成部分。 10. NAnt NAnt是基于.NET的生成工具，与版本Visual Studio.NET 不同，它使得你的项目创建生成过程变得容易。

.Net十大必备工具 1. Snippet Compiler Snippet Compiler 是一个基于 Windows 的应用程序，可以通过它来编写、编译和运行代码。如果具有较小的代码段，并且不希望为其创建完整的Visual Studio .NET项目（及伴随该项目的所有文件），该工具将很有用。 2. Microsoft Source Analysis for C#（StyleCop）微软内部的静态代码检查和代码强制格式美化工具StyleCop的4.2版本Microsoft Source Analysis for C# 。 SourceAnalysis 不是代码格式化工具，而是代码规范检查工具，它不仅检查代码格式，而是编码规范。 3. GhostDoc GhostDoc是Visual Studio的免费插件，可以编写XML格式的注释文档。C#中XML格式的文档注释好处：Visual Studio会显示这些注释内容，还有比如NDoc或微软的文档工具也可以用这些注释生成有良好外观的帮助文件。 4. Sandcastle Sandcastle。这是一个管理类库的文档编译器。它还可通过反射处理汇编源代码，并在代码中使用XML注释生成MSDN形式的文档，这种文档比难以解读的XML更易于理解。 5. Nunit NUnit是一个.NET上的单元测试框架。NUnit 1.x主要是移植JUnit 3.8。从2.0版本开始，NUnit进行了重写和重新设计，使用Attributes代替特定的方法和相应的基类。 6. MyGeneration MyGeneration是一个功能很强大的代码生成工具。通过编写各种类型脚本（C#,VB.Net,JScript,VBScript）的模板，通过数据库的表内容，生成你需要的各种代码。可以用它来生成ORM的实体类，存储过程，SQL语句等。 7. Reflector for .NET Reflector for .NET是一个面向 Microsoft .NET Framework 的免费类浏览器、分析器和DLL反编译器。 8. The Regulator the regulator是很有特色的工具，能使生成和测试正则表达式变得容易。它们在.NET 框架中受到支持。 9. LINQPad LINQ是Language Integrated Query的简称，是集成在.NET编程语言的特性,是编程语言的一个组成部分。 10. NAnt NAnt是基于.NET的生成工具，与版本Visual Studio.NET 不同，它使得你的项目创建生成过程变得容易。

用过NDOC的对生成CHM的项目文档应该不会陌生，可惜那丫居然不再做下去了。还好，MS公司的Sandcastle顶上来了，当然，现在很多高手们也在不断地开发类似NDOC这样的文档生成工具。但用来用去，还是这个比较喜欢，可以自动把其它语言代码也同时生成（类似MSDN）一样。可是网上对这个东东都是一些介绍性的文档，没有说如何使用，这里就把我使用的过程供大家分享，一起学习.当然，我所说的这工具，是在VS...

请到GitHub下载最新版本：Releases · EWSoftware/SHFB · GitHub exe直接运行按提示安装 Sandcastle更新到现在版本为v2015.10.10 根据网址下载Sandcastle 下载下来是一个rar的压缩包 2 解压缩这个压缩包就会看到如下图的这些文件找到exe的可执行文件执行安装 3 进入到安装界面这里的左侧给出了很详细的安装步骤我们可以根据左侧的安装步骤和右侧的说明.

1. 在写代码时注释文档 C#等.NET编程语言能够生成xml注释文档然后可以利用sandcastle生成chm帮助文档 MSDN中推荐的文档注释：http://msdn.microsoft.com/en-us/library/5ast78ax.aspx 2. 可以使用VS自带的csc.exe生成XML文件，使用方法如下： csc.exe/doc:Hello.xml/t:lib...

110,546

社区成员

642,561

社区内容

发帖

与我相关

我的任务

社区管理员

加入社区

近7日
近30日
至今

加载中

查看更多榜单

社区公告

让您成为最强悍的C#开发者

试试用AI创作助手写篇文章吧

+ 用AI写文章