`
didasoft
  • 浏览: 168932 次
  • 性别: Icon_minigender_1
  • 来自: 深圳
社区版块
存档分类
最新评论

用Sandcastle生成CHM1.x中文文档

阅读更多
 

Sandcastle生成CHM1.x中文文档的过程:

需要下载的工具包括:

Sandcastle - October 2007 Community Technology Preview (CTP)

http://www.microsoft.com/downloads/details.aspx?FamilyID=e82ea71d-da89-42ee-a715-696e3a4873b2&displaylang=en

下载下来是Sandcastle.msi,双击安装即可。

Sandcastle只包含了命令行工具,不方便。我们还需要另外一个GUI工具。

Sandcastle Help File Builder

http://www.codeplex.com/SHFB

同样是下载安装就可以了。

然后,在代码中,我们需要写好类和成员的XML注释,并且设置项目生成XML文档。

打开Sandcastle Help File Builder界面,选择需要生成文档的程序集,然后设置一些属性就可以了。

点击Build按钮,生成文档。不一会儿功夫,文档就生成好了。打开一看,还不错。只是发现,除了自己写的注释之外,生成的都是英文文档。很不爽!

只好自己来翻译了。

经过一番苦战,终于完成了。哈哈。

以下是文档的截图,Cool!



如果各位需要翻译好的模版文件,请留言。

分享到:
评论

相关推荐

    Sandcastle(.net程序集CHM帮助文件生成器)

    使用Sandcastle生成文档通常需要以下几步: 1. **安装和配置**:下载并安装Sandcastle,然后配置项目的构建环境,包括设置输入的程序集、输出格式、语言等。 2. **创建项目**:使用Sandcastle的项目文件(.shfbproj...

    Sandcastle-帮助生成工具

    无论是在团队协作还是对外发布产品时,使用Sandcastle生成的文档都能显著提升项目的质量和专业性。安装文件"Sandcastle.msi"则是Sandcastle的安装程序,通过运行此文件,用户可以快速在自己的计算机上部署并开始使用...

    Sandcastle代码帮助文档生成器

    **Sandcastle代码帮助文档生成器** 是一个专为软件开发者设计的强大工具,它能够自动生成专业级别的MSDN风格的文档,极大地简化了开发者们在项目中编写和维护API文档的工作。这个工具支持生成两种格式的帮助文档:...

    Sandcastle加图形工具加中文模板

    自动根据 VS2005 VS2008 的 XML注释生成CHM帮助文档的软件、模板、帮助 包含以下文件: Sandcastle2.4.10520.zip:命令行界面的Sandcast,界面是英文的。 SandcastleBuilderSetup_1801.zip:第三方开发GUI界面方便...

    Sandcastle

    Sandcastle 是一个文档生成工具,可以用它生成 MSDN 风格的文档,既能够生成 chm 文档,也能够生成 MS Help 2.x 帮助文档。在此之前曾流行的 NDoc,其作者已经放弃更新。 参考: ... ... 安装说明:安装...

    SHFB VS 文档生成工具及使用方法介绍

    `Sandcastle Help File Builder (SHFB)` 是一个强大的文档生成工具,专为 .NET 开发者设计,能够将 C#、VB.NET 等编程语言中的代码注释转化为高质量的 API 文档。这款工具的诞生,使得开发者能够更加方便地创建类似...

    SandcastleHelpFileBuilder2017有一个25页的使用说明文档

    注意:如果需要生成chm还需要微软的 MicrosoftHTMLHelpWorkshop 支持,Sandcastle生成时会自动去查找MicrosoftHTMLHelpWorkshop 的安装目录。 安装: 安装很简单,两个软件都只需要直接点击“下一步”即可安装完成...

    SHFB生成CHM的Demo

    标题中的"SHFB生成CHM的Demo"指的是使用Sandcastle Help File Builder(SHFB)创建一个帮助文件(CHM)的示例项目。Sandcastle Help File Builder是一个开源工具,主要用于生成专业的.NET框架程序文档,包括HTML帮助...

    SandCastle Help File Builder V1.9.7.0

    《使用SandCastle Help File Builder V1.9.7.0为C#程序创建专业帮助文件》 在软件开发过程中,为程序提供清晰易懂的帮助文件是至关重要的,它能够为用户指引操作步骤,解答疑惑,提升用户体验。SandCastle Help ...

    WCF接口文档生成工具

    "SHFBGuidedInstaller_2015.01.12.0"这个文件很可能是Sandcastle Help File Builder的安装程序,这是一个流行的.NET文档生成工具。Sandcastle可以帮助开发者生成专业的XML注释文档,包括MSDN风格的HTML帮助文件。...

    Sandcastle和SandcastleHelpFileBuilder

    Sandcastle和SandcastleHelpFileBuilder是微软开发的两个重要工具,专门用于生成高质量的API文档。在IT行业中,尤其在软件开发领域,清晰、详尽的文档是至关重要的,它们帮助开发者理解代码的功能、用法以及接口之间...

    SandCastle 2.4.10520 附件

    2. 构建:使用 SandCastle 工具将预处理后的数据生成 HTML 或 CHM(Microsoft 帮助文件)文档。 3. 后处理:应用定制的样式和布局,如添加自定义徽标或调整颜色方案。 通过理解这些资源的用途和功能,开发者可以更...

    vs注释生成帮助文档

    里面是包含2个工具和一个使用说明文档,通过我自己使用总结的步骤和网上详细的说明。 包含内容: Sandcastle.msi SandcastleGUI.exe 使用帮助.CHM 非常好的通过代码注释生成文档的工具,和MSDN一样酷!

    强大的C#API文档生成工具

    它从dll文件及其xml注释文件能够生成完整的帮助文档,支持多种生成格式(Helpe1x:chm, Helper2x:Hxs, Website,HelperView),结合新发布的Sandcastle Help File Builder可视化工具,整个生成过程十分简单,而且SHFB工具...

    .Net文档自动生成

    Sandcastle是微软提供的一款开源工具,专门用于生成.NET框架类库的API文档,它可以帮助开发者理解和使用代码库,提高开发效率。Sandcastle不仅仅是一个命令行工具,还包括一个图形用户界面(GUI)工具,使得操作更加...

    sandcastle使用小结

    * PresentationStyle 项:有三种选择,选择 vs2005 可以使用中文翻译模板,生成中文的帮助文档。 * SyntaxFilters 项:生成文档中所使用的编程语言,可多选。 * HtmlHelp1xCompilerPath 项:HTML Help Workshop 软件...

    Sandcastle Help File Builder

    对于不同的格式还需要安装不同的编译工具 Helpe1x(chm)需要安装Microsoft HTML Help,Helper2x(Hxs)需要安装 Hxcomp. 5:NamespaceSummaries: 选择需要生成的命名空间,直接点击开窗选择。 6:Lanugages :语言,...

    Sandcastle VS注释文档生成工具

    Sandcastle(CodeName)是微软出的用于编译发布组件(Assembly)信息的一个工具,基本上等同于NDoc(后者已经停止开发很久了)。这个工具通过反射和Xslt技术,可以从dll文件及其xml注释(编译时加/doc参数得到),...

    Sandcastle+SandcastleHelpFileBuilder

    总的来说,Sandcastle和SandcastleHelpFileBuilder是.NET开发者生成专业级API文档的强大工具,它们结合使用可以极大地提高开发效率,确保文档的质量和一致性。通过SHFB的直观界面,即使是初学者也能快速上手,轻松...

Global site tag (gtag.js) - Google Analytics