标签: sandcastle

我们利用沙塔(和SHFB)来从内联XML注释类库文件.这是一个很好的工具,可以保持完整和专业的参考+概述文档,包括正确的代码示例.

不幸的是,这也是狗的慢.这是迄今为止我们自动构建中最耗时的步骤,它开始受到伤害.有没有办法加快速度？

有没有一种从Visual Studio XML输出生成MSDN样式文档的简单方法？
我没有耐心为它建立一个好的xslt,因为我知道我不是第一个跨过这座桥的人.

此外,我最近尝试设置沙堡,但它真的让我的眼睛交叉.要么我错过了一些重要的过程,要么就是太过牵扯.

我知道那里的人有一个非常好的简单解决方案.

我在这里重申,因为我认为我的格式化使该段非邀请阅读:

我尝试了一下沙堡,但很难设置它.我真正想到的是更简单的事情.

也就是说,除非我不理解沙堡过程.对我来说,为了给测试人员提供一些好的东西,这似乎是一件非常多的额外包袱.

我需要一个类似于javadoc的代码文档工具或者用于delphi代码的c#xml doc.什么是最好的工具？我更喜欢一种技术,它在未来与微软沙堡项目兼容.

我只是想知道 - Sandcastle的最后一个版本是从2008年5月开始的,它仍然被列为Pre-Release Software/CTP,它甚至不再获得许可,因为EULA特别指出:

2.TERM.本协议的有效期至2007年9月1日,或软件的商业发布,以先到者为准.

因为Sandcastle相当"重",我只是想知道它是否仍然是正确的使用,或者是否有替代方法来创建XmlDoc文档？(替代品=我可以从我的构建中运行以生成至少HTML,最好是PDF).

当我myproject.shfbproj使用Windows CMD 运行Sandcastle帮助文件生成器项目文件(例如)时,我遇到一个恼人的问题:$(SolutionDir)具有相同的值$(ProjectDir),这意味着项目文档源将无法正确构建,因为我已经添加了自定义目标用途$(SolutionDir).

如果我从Visual Studio构建整个Sandcastle帮助文件生成器,它就会成功构建.

我正在使用以下命令(从存储项目的目录执行):

"C:\Program Files (x86)\MSBuild\14.0\Bin\MSBuild.exe" /p:Configuration=Development myproject.shfbproj

这有什么解决方法吗？

早上好,下午好,晚上好或晚上好(取决于你的时区).

这只是关于C#中XML注释的一般问题.我从来没有对评论我的程序做过很大的贡献,我一直都是一个冗长的变量/属性/方法名称,让代码说明一切.如果我编写的内容相当令人困惑,我会写评论,但在大多数情况下,我不会写很多评论.

我正在阅读有关.NET,Sandcastle和codeplex上的帮助文件构建器中的XML注释的文章,它让我想要记录我的代码并为那些必须深入研究我的人生成一些很好的,有用的文档.代码,当我不在这里.

我的问题是关于标准和惯例.是否有"好"XML评论指南？你应该评论每个变量和属性吗？每个方法？我只是在寻找有关如何编写好的注释的提示,这些注释将由sandcastle编译成良好的文档,以便其他程序员在最终不得不处理我的代码时不会诅咒我的名字.

提前感谢您的意见和建议,Scott Vercuski

背景

我正在开发一个小型编码项目,该项目将被出售给其他公司.我需要为它创建一些文档,所以我决定使用Sandcastle.经过很长时间的下载和安装后,我终于开始工作,并注意到任何没有评论的公共方法或类都有红色文本说明评论缺失.然后我安装了Ghostdoc来帮助加快我的评论速度.这打开了编译器警告缺少xml注释,这很好,因为我现在有一个我需要评论的所有内容的列表.

问题

我的一个代码文件是一个自动生成的文件,其中包含大约3000个编译器警告.我需要能够跳过该文件来创建任何"Missing Xml Comment"编译器警告.我从这篇文章中了解到这些:

• 我知道我可以关闭项目的编译器警告,但项目中还有其他文件应该有编译器警告.
• 我知道我可以#pragma warning disable 1591用来删除编译器警告,但文件是自动生成的,我真的不想每次都要手动重新添加它.
• 我知道我可以添加一个空注释,但是再一次,我真的不想每次重新生成文件时都重新添加它.
• 我可以将文件拉出到它自己的项目中,因为它是它的命名空间中唯一的类,然后删除XML注释要求,但我不希望客户必须处理另一个dll.
• 这些类是局部类,所以我在想试图找到一种方式来添加的#pragma警告禁止在部分类,但即使这是可能的,仍然有将抛出警告枚举.

如何告诉VS忽略特定类型警告的单个文件？

在工作中,我们使用Sandcastle来创建帮助文件.我已经使用SandCastleGUI一段时间了,我正在寻找一种在帮助文件中创建其他页面的方法.这些页面以XML格式编写,称为MAML.唯一的问题是我找不到任何适合这些文件格式的编辑器.

我正在寻找一个WYSIWYG编辑器来创建和编辑其他文档页面.

我正在用注释装饰我的C#代码,所以我可以生成HTML帮助文件.

我经常声明和记录接口.但是实现这些接口的类可以根据实现抛出特定的异常.

有时,客户端只知道他正在使用的接口.我应该通过添加可能由其实现者抛出的异常来记录我的接口吗？

我应该创建/记录自定义异常,以便接口实现者抛出这些而不是框架的异常吗？

我希望这很清楚!

谢谢

编辑2010年1月4日:我决定在http://blog.mikecouturier.com/2010/01/creating-custom-exceptions-in-net-right.html上写一篇关于.NET和自定义异常的博客文章

好奇的问题.我正在使用Microsoft的Sandcastle从我的C#代码中的XML注释生成文档.我的几个类正在实现已经有注释方法的接口.我宁愿不在接口方法和公共实现方法中复制文档.是否有某种标签我可以用来从界面"继承"这个文档？