xml-documentation

2热度

2回答

出于某种原因，我只能看到.net库的文档。有没有办法在Visual Studio中查看我自己的或第三方的文档？我想知道是否有可能在Visual Studio 2010中按Ctrl +空格时看到文档。类似于我在Eclipse中使用的:)。或者至少在方法或类上点击（选择）以便能够在某种视图（窗口）中看到文档时？

1热度

2回答

正确使用派生类的XML内联文档？

虽然我想我理解为什么内联XML文档（即使用三个斜杠 - ///）不适用于我，我想获得关于如何解决我的“问题”的一些指导。我有一个接口和两个派生类。一个派生类用于仿真，另一个用于与真实硬件交谈。这很可能是硬件实现会做一些特殊的事情，模拟器不需要做。我有硬件方法的XML文档，而不是模拟器。但是，当我将鼠标悬停在方法名称上时，我根本没有在工具提示中获取文档，可能是因为XML文档与界面无关。这当然是

14热度

2回答

我可以将XML文档从接口传播到其实现吗？

我需要将XML文档从基类传播到衍生物或从接口传播到实现。我可以使用Resharper来做到这一点吗？

8热度

1回答

用于Xml中cref的Visual Studio Intellisense文档

当您在Visual Studio中为C＃方法创建XML文档（我正在使用2010）时，您会收到用于创建各种XML标记（例如，参见paramref等）的Intellisense支持。另一方面，当你添加一个cref属性时，你必须使用a，我认为它是复杂的格式来描述类型。当你有一些泛型时，这是最糟糕的。我在找什么如下。如果您在see元素中设置cref属性，则您有一个Intellisense列表，它们与您输

11热度

2回答

C＃xml文档：如何创建Notes？

我想在我自己的文档中的this MSDN page备注部分的黄色“备注”框中获得类似的结果。我正在使用sandcastle和sandcastle帮助文件生成器来生成文档标记之外的参考网站。我需要写些什么来实现这样的笔记框？

1热度

1回答

我如何使Sand Castle/MAML中的代码示例中的类名着色

我正在从nDoc迁移到Sand Castle以生成用于我的类引用的文档。 nDoc不支持.net 2.0，还有其他许多限制。此前，在nDoc中，我能够对代码应用漂亮的着色，包括突出显示类名称。 E.g. Console.WriteLine(something)将以不同颜色显示Console（因为nDoc允许您直接在XML中指定HTML样式）。但是，Sand Castle（MAML）似乎忽略了类型

4热度

1回答

如何在没有外部工具的情况下在C＃/ VS2010中自定义自动插入的XML注释

如果键入“///”，VS2010会插入一个xml-doc块。但是，似乎没有办法自定义插入的xml-doc模板。我只找到了一种方法来处理VB.NET或外部工具如GhostDoc。有没有办法做到这一点，没有外部工具？

0热度

2回答

发现无证代码成员在VS2010的解决方案

有谁知道一个简单的工具或Visual Studio宏，将项目中的检测和列表（或在宏的情况下，理想的导航）代码成员和/或解决方案，唐没有任何与它们相关的XML文档？这背后的背景是，除了所有成员需要文档每个成员也需要有一个代码头与修改历史和变更控制号码的事实。这些代码头还使用XML注释符号，比文档更重要。由于我们已经在当前的开发阶段添加了大量新代码，为了应用必要的文档和代码头文件，找到所有未记录的方

6热度

3回答

哪个注释文档格式更适合JavaScript？

对于生成HTML文档的这种格式，JavaScript和处理器是否有任何注释文档格式？目前我正在使用VSDoc xml注释在开发时提供智能感知帮助，但据我所知，没有这种注释的文档生成器。所以或者我的问题听起来像这样：是否有任何实用工具将VSDoc评论从JavaScript文件转换为HTML？

33热度

3回答

汇总中没有显示汇总，如果它被添加为参考

我已经在C＃中创建了一个'类库'，它有许多带有汇总（XML文档注释）的函数。例如 ///<summary> ///Adds the two numbres ///</summary> public void Add() { //statements } 如果我使用的功能在同一个名称空间，其示出了总结，但如果我在一些ohter工作区（溶液）加入其作为参考其没有显示摘要。如