xml-documentation

    19热度

    6回答

    我总是用C#xml语法为类和方法编写漂亮的代码注释。我总是期望能够轻松地在稍后导出它们。 今天我真的必须这样做,但我很难找出如何。有什么我失踪?我想去菜单 - >构建 - >构建代码文档,但没有选择那样做,那里。

    6热度

    3回答

    如何在.Net中内嵌文档成员?让我解释。大多数从注释中提取文档的工具都支持某种内联文档,您可以在成员声明后添加摘要。就像: public static string MyField; /// <summary>Information about MyField.</summary> 有没有办法在C#或.NET语言中做到这一点?

    7热度

    1回答

    我想知道是否有可能在注释中引用动态泛型类名并使其在IDE中有条件地解决? 简单基类,例如: // <summary> // Retrieves all <T> members from the database. // </summary> public void GetAll<T>() { //magic } 如果我现在从该类继承和恰好是类用户然后我想有智能感知显示我的意见是“检

    7热度

    4回答

    我正在记录一个使用XML Documentation Comments的程序集,其中将使用Sandcastle创建一个chm文件。 我的程序集包含各种接口,每个接口都由一个类实现(在我的场景中是WCF服务)。 我已经添加了文档的接口,有没有什么办法让我自动在实现类上记录相关的方法?

    22热度

    3回答

    我在MSDN链接中看到如“CompareOrdinal Overloads”。我如何在C#中编写这样的链接? 我想: <seealso cref="MyMethod">MyMethod Overloads</seealso> 但是,编译器给了我一个关于是对于具有其他重载方法不明确的引用警告。 (初级问题:我是不是真的需要写这个标签链接到重载,抑或是自动文档处理器产生的?)

    2热度

    1回答

    我一直在试图完整记录所有类型,使用XML注释,但遇到了涉及cref属性的奇怪现象方法,属性等一个类库(使用see标签例如)。通过this MSDN page的建议以及MSDN和其他网站上的各种其他示例,似乎每当使用cref标签指定参考值时,它都必须以用于分类refence的特定标记作为前缀(例如'T :'用于类型,'M:'用于方法)。 但是,我发现使用微软Sandcastle时,由于错过了这些前缀

    1热度

    1回答

    这个问题源于这个问题 Code documentation how much is too much? 一个答案是保持你的XML文档在一个单独的文件。我真的很喜欢这个答案,因为当我仔细查看代码时,文档的冗长是烦人的,另一方面,当通过智能感知或发布文档搜索正确的方法时,冗长是有用的。 答案是使用包括标签 /// <include file="Documentation/XML/YourClass.x

    77热度

    9回答

    是否有自动方式来同步接口和其实现之间的注释? 我目前正在记录它们,并且不想手动保持它们同步。 更新:当我创建一流这样 interface IFoo{ /// <summary> /// Commenting DoThis method /// </summary> void DoThis(); } class Foo : IFoo { publ