Linq-to-Sql模型的Web API XML文档(DB First)

时间:2015-05-30 16:04:19

标签: linq-to-sql documentation asp.net-web-api xml-documentation

我正在使用Web API提供一些Web服务。

有一个linq to sql datacontext,它是从数据库自动生成的,我在我的API方法中使用它。 现在要进行文档化,我需要从自动生成的datacontext.designer.cs

中添加XML注释到类以及它们的属性和方法

当我打开.designer.cs文件并强制将XML注释添加到其中时,它会起作用并显示在网站的文档部分中。但是如你所知,它是自动生成的文件,当我更改模型时,我的所有注释都将消失。

我该怎么做才能解决这个问题?

提前致谢。

1 个答案:

答案 0 :(得分:1)

designer.cs file中定义的类创建一个部分类(在不同的文件中),并将要更改XML注释的属性从designer.cs file移动到新创建的类。然后添加适当的注释,无论重新创建自动生成的注释多少次,它们都会保留在那里。