0

我创建了一个项目并开始记录它。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)
    ....
}

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

4

3 回答 3

3

如果您不确定,可以在这里查看... http://msdn.microsoft.com/en-us/library/b2s063f7.aspx

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

但老实说,这正是它应该看起来的样子。除非我对其进行更改,否则我通常会尽量减少所有内容。但是,如果新开发人员加入您的项目,那么完整的 XML 文档可能是天赐之物。

只是克服它,并希望学会爱它?

于 2013-05-15T13:24:47.323 回答
1

该*有一个扩展名:

隐藏/显示评论

*我自己没有尝试过,但看起来它可能会对你有所帮助。

于 2013-05-15T13:51:55.503 回答
0

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

于 2013-05-25T15:05:50.990 回答