Tag: 文档

RavenDB:如何将session.Query转换为session.Advanced.DocumentQuery?

我将以下类的对象存储在ravendb数据库中: public class Continent { public string Name { get; set; } public List Countries{ get; set; } } public class Countries { public string Name { get; set; } public List Provinces{ get; set; } } public class Province { public string Name { get; set; } public List Cities { get; set; } […]

VS中的强制文档(2010)

我只是在搜索如何获取未记录的每个function/成员的errors/warning 。 我很确定我设法在我的一个项目上做到这一点,但无法在我的工作站上找到如何做到这一点。 我已经研究过project道具,解决方案道具,但无法找到它。 我一定错过了什么,或者我可以在家里做一个扩展。 或者也可能是因为我目前正在开发一个VB.Net项目,而不是一个C#项目。 C#和VB之间的行为发生了很大的变化。 谷歌并没有帮助我太多… 编辑:一个小的截图,用法语,抱歉。 所以有些翻译:“编译器”是Build Tab Avertissements = Warning 谢谢

让svcutil从C#文件中获取文档?

伙计们, 我正在创建一个新的WCF服务,并从我的服务界面开始。 看起来像: public interface ISomethingService { /// /// some description /// /// 2.13.0 /// 2009 by myself /// Marc Scheuner /// The request object [OperationContract] SomethingResponse GetList(SomethingRequest request); } 现在,我还在另一个描述SomethingRequest和SomethingResponse消息的文件中创建了一些数据协定。 我编译了我的项目并启动了svcutil.exe以从DLL中提取元数据(WSDL和XSD) – 但我似乎无法弄清楚是否有办法将我的所有注释和解释都放到WSDL / XSD中/节点。 我是否对另一个不起眼的svcutil.exe参数视而不见,或者真的没有办法在元数据中自动生成这个文档? 编辑:好的,根据Marc Gravell的回答,注释和文档字符串不在编译的DLL中,也不在MEX元数据交换协议上可用(可惜!)。 那么:如果您需要向第三方提供访问您服务所需的信息,您如何记录您的WCF服务? 是否存在“NService”或“Sandcastle for WCF”工具,它将扫描我的WCF服务库并从源代码构建WSDL和XSD,包括注释? 似乎无法找到很多工具和方法来做到这一点 – 令我惊讶的是,老实说…. 渣

ASP Web API帮助页面 – 从XML 标记链接到类

我正在开发一个Web-API项目,我对微软的HelpPages自动生成的文档印象非常深刻。 我使用官方网站创建帮助页面启用自定义文档 文档生成成功但是标签中的类的引用似乎都没有添加到描述中,HelpPages只是忽略它们(这是有原因的)。 我真的很想在我的项目中使用这个function,我搜索了很多(有时候很近),但没有一个给出令人信服的答案。 这就是为什么我决定将我的解决方案发布到这个调整,并希望有利于其他程序员,并节省他们一些时间和精力。 (我的回答在下面的回复中)

如何在C#注释中引用类的索引器成员

要在XML注释/文档中引用类的成员,您必须使用以下标记: 这里有更好的解释。 你如何引用索引器 ? 我的意思是,像这样的成员: internal object this[ int index ] { … } 提前致谢。

支持文档中包含哪些核心要素?

我已经创建了一个应用程序,需要在下个月向支持小组“移交” 。 该应用程序相当小 (2个月开发),由两个客户端应用程序和一个数据库组成,它是用Windows平台的c#编写的。 我对支持文档中包含的内容有了广泛的了解 ,但到目前为止我在职业生涯中并不需要提供很多支持文档,我想要包含一个可靠的项目列表。 我想我的目标是让支持小组中每个人的生活 更轻松 ,尽可能无压力。 所以我想我的问题是: 支持文件应该包含哪些内容 您还在支持文档中添加了哪些内容以使其更加有用。 在移交之前可以做些什么其他活动来让我们的生活更轻松?

在Visual Studio 2010中记录(XML)应用程序设置

我最近使用Visual Studio(2010)创建了一个(C#)项目并使用了一些设置(我在Properties下创建)。 我找到的唯一可以在我的文档中添加XML注释的地方是Settings.Designer.cs。 但是,此文件是自动生成的,因此每当我更改“设置”时,注释都会消失。 即使是Visual Studio也开始提供mewarnings,“缺少XML评论,以便宣传明显的类型或成员….” 我的问题是:将XML注释添加到我的设置的最佳方法是什么? 有没有比Settings.Designer.cs更好的地方? 我应该停止自动生成文件吗? 怎么样? 还有别的办法吗? 顺便说一句,我正在使用Sandcastle帮助文件生成器

从C#源文件中提取doc注释

有没有人知道任何允许你直接从.cs文件中提取注释到一些简单文本甚至剪贴板的工具? 如果这样的工具也可以在方法级别工作,那就更好了。 我不是在寻找像Sandcastle那样在构建时工作的东西,我正在寻找适用于单个源代码文件的东西。 基本上我需要将一大块方法签名和相关的文档注释复制到文本文件中,但我很无聊删除“///”并重新格式化行。 我希望能够右键单击一个方法并按照“将文档复制到剪贴板”的方式设置上下文菜单项。 有这样的工具吗?

在使用Sandcastle构建期间自动生成html文档

通过Visual Studio中的构建步骤,我需要采取哪些步骤来自动构建HTML文档? 我已经准备好所有注释并生成了comments.xml文件,并安装了Sandcastle。 我只需要知道要在后期构建步骤中添加什么以生成文档。

我在哪里可以找到一个免费的.Net(C#)库,我可以用来扫描和OCR文件?

我搜索一个免费的.Net(C#)库,我可以用它来扫描文档扫描仪,然后OCR文档,这样我就可以从中获取文本以保存在数据库中。 经过一些搜索,我找不到在Visual Studio 2010和.Net 4中工作的人,有人知道任何类似这样的库吗?