如何本地化 .NET 库的文档
我有一个开源项目(这里)，其 文档 目前为法语.该文档是使用 Sandcastle 从代码中的 XML 注释生成的.现在我想将文档翻译成英文并提供两种语言的文档，但我真的不知道从哪里开始...... 我是否需要从代码中提取 XML 注释并将它们放在单独的文件中?如果是，是否有任何工具可以自动化该过程? 我正在使用 Sandcastle Help File Builder 构建文档；我需要创
..
sandcastle相关内容
是否可以使用 Doxygen、Sandcastle 或其他文档生成器记录 XML?
我目前正在使用 Sandcastle、Doxygen 和 JavaDoc 为我编写的代码生成文档.是否可以使用这些包记录 XML 模式?如果没有，是否有任何(最好是免费的！)包可以做到这一点?我可以自己编写文档作为 Doxygen 或 Sandcastle 中的一个额外概念主题，但我宁愿一个工具为我做这件事！ 一个例子是(虽然我不是 XML Schema 方面的专家！): ///
..
在使用 Sandcastle 构建期间自动生成 html 文档
我需要采取哪些步骤才能通过 Visual Studio 中的构建步骤自动构建 HTML 文档?我已经准备好了所有的评论和正在生成的 comments.xml 文件，并安装了 Sandcastle.我只需要知道在构建后步骤中添加什么即可生成文档. 解决方案 自从提出这个问题以来，已经进行了一些更改.Sandcastle 不再包含 SandcastleBuilderConsole.exe.相反
..
SandCastle 帮助文件生成器:搜索不起作用
我刚刚下载了最新版本的 Sancastle Help File Builder 2017.1.28.0.根据这篇文章的回答和评论，我希望搜索能够正常工作，但它没有.无论我要搜索什么，我都会收到“未找到" 消息.顺便说一句，我没有生成任何 aspx 文件. 我尝试使用 Google Chrome 浏览器 我是否遗漏了任何项目配置? 如何使搜索正常工作? 解决方案 所描述的行
..
delphi 的代码文档类似于 javadoc 或 c# xml doc
我需要一个类似于用于 delphi 代码的 javadoc 或 c# xml doc 的代码文档工具.最好的工具是什么?我更喜欢一种技术，它在未来兼容微软的沙堡项目. 解决方案 看一看 SynProject，一个用 Delphi 编写的开源工具. 它旨在处理完整的文档工作流程，从规范到发行说明，包括测试、架构和设计；当然，还有一个集成的 Delphi 解析器，可以从现有的 Delph
..
部分类/方法的 XML 注释
用于生成 API 文档的工具是否有一种标准方法来处理对部分类的 XML 样式注释?基本上，应该如何评论部分类/方法，以便生成的帮助文档不会被破坏?这个问题可能因使用的工具而异，在这种情况下，我想最重要的两个工具是: Visual Studio 创建 XML 文档的内置方法 微软的沙堡 我不希望我的 XML 文档变得时髦 ///一些Foo类公共部分类 Foo { ... }///
..
隐藏从Sandcastle生成的文档中从Object继承的方法?
如何从Sandcastle生成的文档中隐藏从Object类继承的方法(例如Equals，Finalize，GetHashCode，GetType等).我有一个名为LicenseManager的类，它具有一个方法，并且Object继承的方法阻塞了显示. 我正在使用最新版本的Sandcastle + Sandcastle帮助文件生成器. http://cl.ly/3Y2p1C0m1a3f1
..
如何使沙堡包括继承的属性
我的视图模型有2个POCO类: public class BaseView { public int Id { get; set; } public string Name { get; set; } } 和 public class FullView : BaseView { public string Reference { get; set; }
..
如何在Sandcastle帮助文件中包含自定义文档注释元素?
在C#中，如果我有添加XML文档的方法，则默认情况下将生成以下内容: /// /// Does something /// public string SomeValue { get; set; } 我想在下面添加我自己的文档注释，这在VS.NET构建中就可以了: /// /// /// ///
..
在SHFB生成的.chm中包含PDF文件(HTML帮助文件1)
我需要在我的沙堡文档中包含一个pdf文件.在.chm文件中单击时，用户应该能够导航到pdf.是否有可能做到这一点?我一直在搜索所有论坛，没有正确的答案. 我尝试在xml注释中使用href标记并提供pdf文件的网址.但是它将打开浏览器，而不是pdf文件. 有人做过吗? 解决方案 我为您提供了下载链接: http://www.help-info.de/files_download/CHM-e
..
从另一个索引器继承文档的语法是什么?
在我的实现中，我有这个: /// public T this[long row, long column] { ... } 中已经存在XMLdoc.我怎样才能从那里拿起它(就像我做其他事情一样)? 我收到编译器警告: 对"XXX.YYY.this [long，long]"的108条X
..
使用帮助库管理器和WiX安装帮助
我试图通过使用WiX运行Sandcastle帮助文件生成器在构建Sandcastle项目后创建的HelpLibraryManagerLauncher，将自己的帮助文件添加到Visual Studio 2010的帮助库中. 我正在使用WiX的QuietExec自定义操作来运行以下命令: HelpLibraryManagerLauncher.exe /product "VS" /v
..
Sandcastle不会从F#程序集输出所有内容
它仅识别顶级非函数值声明. 例如令a = 2 并且不提供有关函数或类型定义的文档. 我已经检查了xml文档文件，并在源代码中添加了所有///注释，但最终的html中都没有显示(顶级值除外). 解决方案 是的，使用以C#为中心的工具生成F#文档通常很可怕.我们不久前开始了一个替代项目，但它还不如SandCastle成熟: http://bitbucket. org/IntelliFac
..
如何引用其他方法的参数?
是否可以从与您为其编写摘要的方法不同的方法中引用参数，如果是，则语法是什么. 我了解，但是我不知道如何通过其他方法进行引用. 一个简单幽默的例子，以防万一我不清楚: /// /// Does magical Foo things! /// /// Magi
..
我应该如何记录继承的成员?
考虑到我有一个复杂的类结构，其中许多元素是从其他元素继承的.我可能在接口中定义了方法GetStuff(string stuffName, int count)，该方法由其他接口继承，然后由抽象类抽象地实现，然后在具体类中显式实现，等等. 在使用XML注释记录我的代码时，我该如何处理诸如GetStuff()之类的继承成员，这些注释将与Doxygen或Sandcastle之类的工具一起使用?仅在
..
可以在Sandcastle文档中包括自定义属性吗?
是否可以在Sandcastle文档中包含自定义属性? 例如，考虑以下c#方法: public void ExampleMethod ( [Required] string input1, [DefaultValue("example")] string input2 ) 有什么方法可以使沙堡文档输出的input1具有必需的属性? 解决方案 这适用于属性和类，但我
..
沙堡帮助构建器:搜索功能
我对SandCastle的输出感到非常满意，但我也想在HTML输出中包含一些搜索功能，这可能吗? 解决方案 SandCastle帮助文件生成器的网站输出包含 index.aspx 和 index.html . > 如果显示 index.html ，则不会显示搜索或索引选项: http://www.ewoodruff.us/shfbdocs/index.html 如果显示 index
..
如何使用Sandcastle NuGet软件包(EWSoftware.SHFB)生成文档?
我正在尝试使用Visual Studio(EWSoftware.SHFB)中的Sandcastle的NuGet包为C#代码生成网站文档.事实是我不知道如何使用它.我是从NuGet程序包管理器安装它的，然后我不知道如何处理它. 使用默认安装程序安装的VS Sandcaslte扩展名，我可以编辑自己的文档项目并生成相应的网站. 谢谢您的帮助. 解决方案 MsBuild.exe My
..
可以使用Doxygen，Sandcastle或其他文档生成器来记录XML吗?
我目前正在使用Sandcastle，Doxygen和JavaDoc为我编写的代码生成文档.是否可以使用这些软件包来记录XML模式?如果没有，是否有任何软件包(最好是免费的！)可以做到这一点?我可以自己编写文档，作为Doxygen或Sandcastle中的一个额外的概念性话题，但我宁愿使用一种工具为我做这件事！ 一个例子是(尽管我不是XML Schema的专家！): ///
..
代码文档：多少太多？
.NET源代码中的代码文档太多了？ 某些背景：我继承了一个大型代码库，在其他一些代码中我已经谈到我在此处发布的问题。该代码库的“功能”之一是God类，它是一个静态类，具有超过3000行代码，包含数十种静态方法。从 Utilities.CalculateFYBasedOnMonth（）到 Utilities.GetSharePointUserInfo（）到 Utilities.IsUserIE
..