使用CSDL记录实体

时间:2010-12-29 22:40:06

标签: entity-framework documentation

CSDL包括文档/摘要和文档/ LongDescription元素,according to MSDN可用于记录实体。这些元素的内容可以方便地显示在实体设计图面的属性窗口中,因此当您使用实体时,很容易在这些字段中记下一些注释。

由于EDMX文件是XML,因此编写XSLT样式表以从这些元素中提取文档会很容易。这样做有标准的工具吗?使用CSDL文档字段还有其他优点吗?是否有人使用这些字段,如果是这样,您是否发现它们是记录实体的有效方式?

1 个答案:

答案 0 :(得分:1)

存储在CSDL中的文档数据在生成的代码中作为XML doc注释发出。因此,它将自动出现在Visual Studio中的intellisense工具提示中:

alt text

如果您想将它用于更正式的文档,您可以使用SandCastle(可选择与优秀的前端SHFB)或其他一些Xml DocComment提取工具来构建Windows帮助文件或帮助网站包含文件。

如果使用SQL Server中的文档属性记录数据库,则可以从数据库中提取该文档,并使用此工具填充SSDL和CSDL注释:http://huagati.com/edmxtools/