基本上,什么时候(如果需要的话)才需要使用完全合格的 XML 查看参考文档: <see cref="T:MyNamespace.Sub.MyType"/> //Option 1 <see cref="T:MyType"> //Option 2 此外,对于引用.NE...
我在一个团队中工作,我们使用广泛的StyleCop规则集,我想知道这样的工具何时停止有用并开始变得恼人。我们还使用GhostDoc,所以代码中充满了XML注释,这使得代码变得更难读,难以审核。我对XML注释没有问题,在某些地方我发现它们非常有用,但是它们真的需要在每个字段和属性上吗? 我们有...
有没有一种标准的方法,可以用来处理对部分类使用XML样式注释的工具生成API文档?基本上,应该如何注释部分类/方法,以便生成的帮助文档不会出现混乱?这个问题可能会因使用的工具而有所不同,在这种情况下,我想最重要的两个工具是: Visual Studio内置的创建XML文档的方法 Micro...
我知道remarks标签用于提供有关类的附加信息,但在悬停/调用该类时不会显示在智能感知中。我想知道它在哪些方面是有用的? 我了解remarks标签可用于提供类的额外信息,但在悬停或调用该类时,它不会在智能感知中显示。请问它在哪些方面是有用的呢?
有没有一种简单的方法可以从Visual Studio XML输出中生成MSDN风格的文档? 我不太耐心去设置好它的xslt,因为我知道我不是第一个遇到这个问题的人。 另外,我最近尝试了一下安装Sandcastle,但是它真的让我晕头转向。要么是在整个过程中我错过了一些重要东西,要么就是它涉及...
我想在web.config文件中加入注释,类似这样:<httpRuntime requestValidationMode="2.0" // require for [ValidateInput(false)] in .net-4.0 requestPathInvali...
这实际上只是重新提问有关Visual Studio 2008的此问题。 VS2010是否提供任何功能来消除自动生成代码的CS1591编译器警告? CS1591:公开可见类型或成员缺少XML注释 引用VS2008的问题: 这只是一个烦恼而不是问题。 我的项目包含许多自动生成的文件(使用mg...
好的,这是一个愚蠢的问题,但在使用Visual Studio时,如果我正在用Visual Basic编写XML文档注释,我可以使用Tab键在字段之间切换(例如从概要到Param到Returns)。 但是,在C#中,按Tab键会插入制表符,因此我必须单击各个字段以导航到它们(或使用箭头键)。 这...
在 C# 中,我试图使用 <see cref="blah"/> 引用一个包含 params 关键字的方法签名。我知道这将参数列表转换为数组,但我甚至无法想象如何在 CREF 属性中引用数组。在我的搜索中找不到任何信息,我认识的人也没有任何想法。编译器在方括号处出现问题。我尝试了各种...
我正在尝试让VB.NET的XML注释与IntelliSense配合使用,也许它的工作方式不是我想象的那样。 ''' <summary> ''' Gets or sets the Patient Code. ''' <list type="bullet"&...