Xml Documenting EF Code First Tables

时间:2013-01-28 23:40:46

标签: c# visual-studio entity-framework ef-code-first

我知道我可以使用以下语法记录我的表:

/// <summary>
/// Insert table description here.
/// </summary>
public class SomeTable
{
    public int someNumber { get; set; }
    public string someString { get; set; }
}

当我像这样使用表时,会显示相应的摘要:IQueryable<SomeTable> query;但是,如果我要在LINQ中使用该表:

var query = from p in db.SomeTable
            select p;

我不会获得该表的任何智能感知描述。显然,解决方案是使用相同的描述记录我的DbContext中的行public DbSet<SomeTable> SomeTable { get; set; },但从长远来看,这似乎不易维护。有没有办法可以得到我想要的东西,而不必为每一张桌子重复自己?

1 个答案:

答案 0 :(得分:0)

XML文档对IntelliSense没有太大帮助(如果你只是在谈论代码完成 - 我知道如果你记录你的方法/属性,你会得到一个附加弹出窗口的信息)。

但秩序真的很重要。例如,如果你说:

var invoices = from inv in db.Invoices
               join cust in db.Customers on inv.CustomerId equals cust.CustomerId
               where cust.CustomerId == myCustId
               select inv;

那么你将获得智能感知。但是如果你改变了连接的条件(cust.CustomerId等于inv.CustomerId),那么你就不会得到任何适用于该条件的IntelliSense。

编辑: 刚刚注意到OP主要对IntelliSense 描述感兴趣。没有自动化的方法,因为你基本上想要在另一个类的属性上看到你的类的描述。

属性和类应该有单独的描述。如果房产不仅仅是退回桌子怎么办?