标签: xml-comments

我更喜欢使用反射器浏览程序集，即使我有源代码，特别是当我移动到新项目时。但我觉得如果能在 Reflector 中看到源代码的 XML 注释就好了。

有任何插件可以做到这一点吗？

提前致谢，乌代

我有一个这样的方法：

/// <summary>
/// Gets a typed Dictionary of <see cref="T:System.Collections.Generic.Dictionary`2"/> 
/// </summary>
/// <returns></returns>
public Dictionary<string, object> ToDictionary()

当我调用此方法并查看智能感知时，它显示它返回 Dictionary<TKey,TValue>

有没有办法让智能感知显示 Dictionary<string, object>

我尝试了以下但失败了：

<see cref="System.Collections.Generic.Dictionary`2[System.String,System.Object]"/>

这是我所看到的：

我正在构建应用程序,其中一个要求是使用类似这样的注释:

/// <summary>
/// Creates new client.
/// </summary>
/// <param name="uri">The URI.</param>
/// <param name="param">The param.</param>
/// <returns></returns>

据我所知,各种工具很容易根据这些xmls生成文档.但它显着降低了代码的可读性,而这正是我们人类试图实现的目标.

这种方法可以被.Net中的任何其他技术取代吗？什么是提高代码可读性和清洁度的更好方法？

我正在用以下签名编写一个简单的比较功能：

  /// <summary>
  /// Casts two unsigned integers to signed integers and compares them
  /// </summary>
  /// <param name="arg1">Left side of inequality</param>
  /// <param name="arg2">Right side of inequality</param>
  /// <returns>
  /// LESS_THAN if arg1    <----
  /// </returns>
  private static Inequality Compare(uint arg1, uint arg2)

我想将文字不等式符号放在箭头所在的位置，而不会触发XML解析器。我怎样才能做到这一点？

我一直在使用XML注释来记录我在VB.Net中的源代码(当我到达时,还有C#).我似乎记得很久以前有人告诉我,有一种方法可以自动将XML注释导出为文本文档或其他格式,以便在Visual Studio之外进行简单的引用.在那儿？它是什么,或者是它们？

下面的代码是否是有效的XML？

<sometag
    attribute1="value1"
    <!-- attribute2="value2" -->
    attribute3="value3">

</sometag>

如果我有以下功能:

void ReadData(Action<DataContext> action) {}

我如何在seealso构造中引用它？

<seealso cref="ReadData(Action<DataContext>)"/>

抱怨"字符'<'不能在属性值中使用".将"<"和">"更改为"{"和"}"有效但会使其成为开放的通用参数.

我喜欢XML评论.然而,随着一切崩溃,每两行看起来像:

[/// summary ...]
public void CreateUser(string username, string password)[...]

将此乘以数十或数百种方法,并且生成的折叠代码很难筛选出来. 我可以将这些注释移动到单独的XML文件中,并且仍然让Visual Studio识别该关联,以便它们仍然显示在Intellisense中吗？如果是这样,我该如何建立这种关联？我还使用SandCastle根据这些注释生成文档,因此SandCastle也必须识别该关联.

有没有一种方法(工具或其他东西)允许在从基类继承/重写方法时不重复相同的XML注释？

例如.:

/// <summary>
/// Represent a brand new object in .NET
/// </summary>
public class MyObject : Object
{
    /// <summary>
    /// Copy-Paste the same Xml comment 
    /// like in the base class is boring!
    /// </summary>
    /// <param name="obj">and params too!! ((</param>
    /// <returns>this one too!!! (((</returns>
    public override bool Equals(object obj)
    {
        return base.Equals(obj);
    }
}

我有一些使用doxygen注释的C#代码用于某些方程式.VS2013应该给我一个警告信息

warning CS1570: XML comment on 'myclass' has badly formed XML -- 
'A name was started with an invalid character.'

我的评论如下,"<"引发了此警告消息.

/// \f[
/// T_{max}<30
/// \f]

我真的要摆脱这个警告信息.最好的选择是不要更改编译选项以忽略此警告.

我该如何解决？谢谢你的任何建议.