在EF生成的類中爲屬性/字段添加XML文檔/註釋

Question

我有習慣用標準XML文檔評論屬性和類，它是什麼意思/他們做什麼。

但是在EF生成的課程中，當我重新生成模型時，這些都消失了。

是否有另一種方法可以做到這一點？

Answer 1

正如Ladislav在他的回答中所述，您需要修改T4模板，以便將註釋包含在生成的代碼中。這個答案取自this article：

首先，您需要在模型設計器的屬性框中指定您的註釋。在文檔 - >長描述和摘要下。

然後在模板中，可以例如添加此要記錄的屬性上面：

<#if (!ReferenceEquals(edmProperty.Documentation, null)) 
{ 
#> 
/// <summary> 
/// <#=edmProperty.Documentation.Summary#> – <#=edmProperty.Documentation.LongDescription#> 
/// </summary> 
<#}#> 

這將創建生成的代碼你的財產之上的摘要塊。

Answer 2

不需要。您將不得不修改用於生成類的T4模板（或爲類生成創建新的自定義工具）以爲您提供這些註釋。

Answer 3

EF生成的類都是「部分」類。因此，定義一個具有相同類骨架結構的新文件，並定義對這些文件的評論。

例子：

的EF生成的類（Model.designer.cs）：

public partial class Student : EntityObject {... // bunch of generated code} 

自己的文件（ModelDocumentation.cs）：

/// <summary> Student documentation... </summary> 
public partial class Student {}