我创建了一个项目并开始记录它。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)
....
}
有没有办法清理这段代码,同时留下足够的信息来创建一个很好的帮助文件?