Question

我已经创建了一个项目并开始记录它。 Sandcastle使用XML注释创建一个很好的帮助文件，但XML注释使代码几乎不可读。我现在写的每个课程都是从这样开始的：

/// <summary>
/// Summary of Foo class
/// </summary>
public class Foo
{
    ///<summary>
    ///Summary of bar</summary>
    public int bar;
    ///<summary>
    ///Summary of bat</summary>
    public String bat;

    ///<summary>
    ///Summary of constructor</summary
    ///<param name="a">description of a</param>
    ///<param name="b">description of b</param>
    public Foo(int a, int b)
    ....
}

有没有办法清理这些代码，同时留下足够的信息来创建一个好的帮助文件？

Answer 1

如果您不确定，可以浏览一下...... http://msdn.microsoft.com/en-us/library/b2s063f7.aspx

以下是他们的例子： http://msdn.microsoft.com/en-us/library/aa288481(v=vs.71).aspx

但老实说，这应该是它看起来的样子。除非我对其进行更改，否则我通常会将所有内容都保持最小化。但是，如果新开发人员加入您的项目，那么像这样的完整XML文档可能是天赐之物。

只是通过它来战斗并希望学会喜欢它？

Answer 2

^*：

有一个扩展名

Hide/Show Comments

^{* _{我自己没试过，但看起来它可能对你有帮助。}}

Answer 3

include tag允许您将大部分文档放在单独的文件中。通常，这用于在虚拟或接口成员的各种实现中重用通用文档，但它也可用于简单地分离文档。

无阻碍的XML评论

3 个答案: