T4模板根据数据库表和列的Description生成代码的summary的终极解决方案

相信不少人都用T4模版生成代码，用T4模版生成标准代码真的很方便。咱们常常根据表生成相关的代码， 可是估计不少人都碰见过同一个问题， 特别是咱们在生成model的时候，代码中model中的Summary一直没法生成。这个问题也困扰了我好久，也找了不少方案，一直没有更好的方法。问题以下：

解决方案

为了生成summary须要额外的增长一个类，并在T4模版中引用这个类便可。这个类的做用是根据表名和列名提取数据表中列的description。

1. 首先查询数据库中全部表和列的基本信息

为了方便起见，我在数据库中建立了一个视图，视图结构以下：

 

sql 脚本以下：

SELECT   TOP (100) PERCENT COALESCE (T.name, OBJECT_NAME(C.object_id)) AS TableName, TB.TableDESC,
                C.name AS ColumnName, TYPE_NAME(C.user_type_id) AS DataType, D.definition AS DefaultSetting,
                C.is_nullable AS IsNullable, C.max_length AS MaxLength, COLUMNPROPERTY(C.object_id, C.name, 'PRECISION')
                AS Precision, P.value AS ColumnDESC
FROM      sys.columns AS C LEFT OUTER JOIN
                sys.table_types AS T ON T.type_table_object_id = C.object_id LEFT OUTER JOIN
                sys.default_constraints AS D ON C.object_id = D.parent_object_id AND
                D.parent_column_id = C.column_id LEFT OUTER JOIN
                sys.extended_properties AS P ON (P.major_id = C.object_id OR
                P.major_id = T.user_type_id) AND P.minor_id = C.column_id AND P.name = 'MS_Description' LEFT OUTER JOIN
                    (SELECT   INFORMATION_SCHEMA.TABLES.TABLE_NAME AS TableName, P.value AS TableDESC
                     FROM      INFORMATION_SCHEMA.TABLES LEFT OUTER JOIN
                                     sys.extended_properties AS P ON
                                     OBJECT_ID(INFORMATION_SCHEMA.TABLES.TABLE_SCHEMA + '.' + INFORMATION_SCHEMA.TABLES.TABLE_NAME)
                                      = P.major_id AND P.minor_id = 0
                     WHERE   (INFORMATION_SCHEMA.TABLES.TABLE_TYPE = 'BASE TABLE')) AS TB ON COALESCE (T.name,
                OBJECT_NAME(C.object_id)) = TB.TableName
WHERE   (COALESCE (SCHEMA_NAME(T.schema_id), OBJECT_SCHEMA_NAME(C.object_id)) = 'dbo')
ORDER BY TableName

 

2.在代码中计算description

 

3.T4模版调用

前面已经建立了一个类，这个类很简单，就是根据表名和列名获取对应的description。如今只要在T4模版中引用这个类便可。代码中要注意两点。直接上代码：

1. 必需要在T4模板的头部引用上面类的dll，不然没法引用命名空间。我用的是相对路径。其中$(SolutionDir)表示的solution所在的文件夹。

2.引用命名空间，下图中红线部分2行

在T4模板中直接调用方法便可，这样就能够根据表个列表获取到相应的description做为类的summary了。

 

这里提到一点，T4模版的代码中这个我用了一个replace，是由于我在写列描述的时候有换行，因此我把数据库中的换行转换成了summary中的换行，效果以下：

 

生成的代码的demo

跟你们提供几个生成代码的截图吧，怎么样全部的summary都已经根据数据库生成出来了吧

 

总结

我的认为这个方法是最简单的方法也是最有效的了，应该没有比这个在简单了。欢迎你们拍砖