向实体框架生成的实体添加文档

Posted 2023-03-28

【中文标题】向实体框架生成的实体添加文档

【英文标题】：Add documentation to entity framework generated entities

【发布时间】：2014-10-26 10:12:45

【问题描述】：

T4 为我生成了一些这样的实体：

public partial class Use


    public int UseId  get; set; 
    public int ProgramId  get; set; 
    public System.DateTime InUseDate  get; set; 

我想向该实体添加文档。我继续如下：

[MetadataType(typeof(UseData))]
public partial class Use  


public class UseData

    /// <summary>
    /// This is an ID
    /// </summary>
    [Display(
        Name = "Use ID",
        Description = "This is an ID Desc")
    ]
    public int UseId;

但是 VS 自动完成不会显示我的 UseIdattribute 的摘要。

任何想法

【问题讨论】：

不错的尝试，但我没想到这会奏效。 Metadata 类用于查找属性上的属性（元数据），XML cmets 不是元数据。

使用 EF Reverse POCO 模板！ visualstudiogallery.msdn.microsoft.com/…

是的，我就是这么认为的 Henk。我试图将摘要注释直接添加到我的第二个部分类中，但它不起作用，VS 告诉我我的属性已经定义。

我认为 property 已经定义好了。

@ErikEJ - 究竟有什么帮助？您可以修改任何 T4 以添加“获取或设置 UseId”。

【参考方案1】：

如果您使用的是 EDMX，您只需转到设计器中的实体属性，打开 Visual Studio 属性选项卡并填写文档。

使用 xml 摘要生成代码...

    /// <summary>
    /// Database and Application Version
    /// </summary>
    [EdmScalarPropertyAttribute(EntityKeyProperty=true, IsNullable=false)]
    [DataMemberAttribute()]
    public global::System.Int32 MajorVersion
    
        get
        
            return _MajorVersion;
        
        set
        
            if (_MajorVersion != value)
            
                OnMajorVersionChanging(value);
                ReportPropertyChanging("MajorVersion");
                _MajorVersion = StructuralObject.SetValidValue(value);
                ReportPropertyChanged("MajorVersion");
                OnMajorVersionChanged();