Linq to SQL的C#XML文档

Kat*_*tia 6 c# linq documentation dbml linq-to-sql

如何记录使用LINQ to SQL DBML自动生成的类和属性和函数?

我设法通过在另一个文件中定义相同的部分类来为datacontext类提供文档,<summary>因此如果DBML被刷新则不会被删除

/// <summary>  
/// Linq to SQL datacontext  
/// </summary>  
public partial class LinqDBDataContext {  

}
Run Code Online (Sandbox Code Playgroud)

这适用于表映射类,其中一个缺点是必须手动维护添加/删除表的单独类.

另外一件事.我在存储过程中有类似注释的文档(作者,日期和描述),不应该作为函数的文档提取到代码文件中吗?

-- =============================================
-- Author:      <Katia Aleid>
-- Create date: <2015-04-01>
-- Description: <Performs search for the users>
-- =============================================
ALTER PROCEDURE [dbo].[SearchUsers] ....
Run Code Online (Sandbox Code Playgroud)

是否可以排除DBML表单C#文档并改为使用单独的数据库文档?

Mar*_*ell 1

存储过程中的注释不太可能被 SqlMetal 解析;在推送时MS_Description如果您分配了一些扩展元数据,它可以访问扩展元数据 - 但是,我不希望它这样做。查看 dbml 元数据内部,没有明显的地方可以存储或编辑附加注释,所以坦率地说,我怀疑这里的答案是:你不需要。您不应该编辑*.designer.cs,因为它可以随机重新生成。