LINQ to SQL DBML を使用して自動的に生成されるクラスとプロパティと関数を文書化する方法は?
<summary>
DBML が更新されても削除されないように 、別のファイルで同じ部分クラスを定義することにより、datacontext クラスにドキュメントを提供することができました。
/// <summary>
/// Linq to SQL datacontext
/// </summary>
public partial class LinqDBDataContext {
}
これは、追加/削除されたテーブル用に別のクラスを手動で維持する必要があるという欠点があるテーブル マッピング クラスで機能します。
別のこと..ストアドプロシージャにコメントのようなドキュメント(作成者、日付、説明)がありますが、関数のドキュメントとしてコードファイルに抽出するべきではありませんか?
-- =============================================
-- Author: <Katia Aleid>
-- Create date: <2015-04-01>
-- Description: <Performs search for the users>
-- =============================================
ALTER PROCEDURE [dbo].[SearchUsers] ....
DBML フォーム C# ドキュメントを除外し、代わりに別のデータベース ドキュメントを使用することは許容されますか?