数学関数を表す多くの静的フィールドを持つ静的クラスがあります。たとえば、クラス「Integer」には、整数に関連する関数を表す「GreaterThan」、「Add」などのプロパティがあります。
この環境は、開発者以外のユーザー (つまり、ソース コードやコメントにアクセスできない) が Linqpad でアドホック関数とクエリを作成するために使用されます。これらのフィールドに XML コメントを追加して、返されるデータ型とパラメーターの型を説明し、それらのコメントが Linqpad のオートコンプリートに表示されるようにしたいと思います。たとえば、整数の「ログ」関数は、値と基数の 2 つのパラメーターを取りますが、エンド ユーザーにとっては、コメントなしで (または不正行為をしてソース コードを見て)、どれがどれであるかを判断するのは容易ではありません。「ベースは先か後か？」など。
フィールドの XML コメントを取得して Linqpad のオートコンプリートに表示する方法がわかりません。コードベースの他の場所に、XML コメントを含む C# インターフェイス メソッド (プロパティではない) があり、Visual Studio のプロジェクト プロパティで [XML ドキュメント ファイルを出力] オプションをオンにすると、LinqPad に表示されます (少なくとも、 LinqPad オートコンプリート ウィンドウに「概要」タグが表示されます)。
インターフェイスメソッドでは、これは機能し、Linqpad のオートコンプリートに「クエリの実行」が表示されます。
/// <summary>
/// Execute a query
/// </summary>
void Execute(Query query);
しかし、このような静的フィールドの場合、概要テキストが Linqpad のオートコンプリートに表示されません。
/// <summary>
/// Log function (returns a float, first param is value, second is base)
/// </summary>
public static Function Log = new Function("Log", DataType.Float, DataType.Integer, DataType.Float);
Linqpad がこの方法で静的フィールドの文書化をサポートしているかどうかを知っている人はいますか?もしそうなら、オートコンプリートに表示する方法を知っていますか?
現在、LinqPad バージョン 4.47.02 を使用しています。
ありがとう！
更新:「プロパティ」と間違って呼んでいましたが、代わりに「静的フィールド」と言うべきでした。修正してくれたsgmooreに感謝します。