How to add member documentation to generated entity members

Posts   
 
    
MarkDerman
User
Posts: 1
Joined: 07-Nov-2007
# Posted on: 07-Nov-2007 15:44:44   

Hi

What is the best strategy for including inline code documentation for each generated Field of an Entity? i.e. Have my own documentation in the <summary> section of the generated code below???

Cheers,

Mark

/// <summary> The CommissionPercent property of the Entity Enquiry<br/><br/> /// </summary> /// <remarks>Mapped on table field: "Enquiry"."CommissionPercent"<br/> /// Table field type characteristics (type, precision, scale, length): Decimal, 18, 0, 0<br/> /// Table field behavior characteristics (is nullable, is PK, is identity): false, false, false</remarks> public virtual System.Decimal CommissionPercent { get { return (System.Decimal)GetValue((int)EnquiryFieldIndex.CommissionPercent, true); } set { SetValue((int)EnquiryFieldIndex.CommissionPercent, value, true); } }

Walaa avatar
Walaa
Support Team
Posts: 14995
Joined: 21-Aug-2005
# Posted on: 07-Nov-2007 16:26:24   

Currently there is no support for this in the Designer. (It's on the todo list for future releases).

Same question was asked here: http://www.llblgen.com/TinyForum/Messages.aspx?ThreadID=9604

Otis avatar
Otis
LLBLGen Pro Team
Posts: 39908
Joined: 17-Aug-2003
# Posted on: 08-Nov-2007 11:47:43   

You could add custom properties name-value pairs, which are generated into the generated code XML comments.

Frans Bouma | Lead developer LLBLGen Pro