シグネチャ

[アーティクル]
04/07/2023

シグネチャファイルには、型、名前空間、モジュールなど F# プログラムの一連の要素のパブリックシグネチャに関する情報が含まれています。これらのプログラム要素のアクセシビリティを指定するために使用できます。

解説

それぞれの F# コードファイルでは、 シグネチャファイル(.fs の代わりに .fsi の拡張子を持つ、コードファイルと同じ名前のファイル) を使用できます。コマンドラインを直接使用する場合に、シグネチャファイルをコンパイルコマンドラインに追加することもできます。コードファイルとシグネチャファイルを区別するために、コードファイルは " 実装ファイル" と呼ばれることもあります。プロジェクトでは、シグネチャファイルが、関連するコードファイルよりも優先されます。

シグネチャファイルは、対応する実装ファイル内の名前空間、モジュール、型、およびメンバーについて説明します。シグネチャファイルの情報を使用して、対応する実装ファイルのどのコードの部分に、実装ファイルの外部コードからアクセスできるのか、また、どの部分が実装ファイルの内部用なのかを指定します。シグネチャファイルに含まれる名前空間、モジュール、型は、実装ファイルに含まれている名前空間、モジュール、型のサブセットである必要があります。このトピックの後半で例外をいくつか挙げますが、シグネチャファイルにリストされていない言語要素は、実装ファイルのプライベートな要素と見なされます。プロジェクトまたはコマンドラインでシグネチャファイルが見つからない場合は、既定のアクセシビリティが使用されます。

既定のアクセシビリティの詳細については、「アクセスの制御」を参照してください。

シグネチャファイルでは、各メソッドおよび関数の型および実装の定義は繰り返しません。代わりに、各メソッドおよび関数のシグネチャを使用します。これは、モジュールまたは名前空間のフラグメントによって実装されている機能の完全な仕様として機能します。型シグネチャの構文は、インターフェイスと抽象クラスの抽象メソッドの宣言で使用される構文と同じです。また、正しくコンパイルされた入力を表示するとき、IntelliSense および F# インタープリター fsi.exe によっても表示されます。

型がシールされているかどうか、またはインターフェイス型であるかどうかを示す十分な情報が型シグネチャにない場合、コンパイラに型の性質を示す属性を追加する必要があります。次の表に、この目的で使用する属性を示します。

属性	説明
`[<Sealed>]`	抽象メンバーを持たない型、または拡張する必要がない型の場合。
`[<Interface>]`	インターフェイスである型の場合。

シグネチャと実装ファイルの宣言との間で属性が一致しない場合、コンパイラはエラーを生成します。

キーワード val を使用して、値または関数値のシグネチャを作成します。キーワード type は、型シグネチャを導入します。

--sig コンパイラオプション使用して、シグネチャファイルを生成できます。通常、.fsi ファイルは手動で作成しません。代わりに、コンパイラを使用して .fsi ファイルを生成し、そのファイルをプロジェクトに追加します。既にファイルが存在する場合、アクセスできるようにしたくないメソッドや関数を削除することによって編集します。

型シグネチャには、以下のようないくつかのルールがあります。

実装ファイルの型略称は、シグネチャファイルの省略しない型と一致してはなりません。
レコードと、判別された共用体は、フィールドとコンストラクターをすべて公開するか、または一切公開しない必要があります。また、シグネチャの順序は、実装ファイルの順序と一致している必要があります。クラスは、シグネチャのフィールドとメソッドの一部またはすべてを表示することも、あるいは一切表示しないこともできます。
コンストラクターを持つクラスと構造体は、基底クラスの宣言 ( inherits の宣言) を公開する必要があります。また、コンストラクターを持つクラスと構造体は、抽象メソッドとインターフェイス宣言すべてを公開する必要があります。
インターフェイスの型は、すべてのメソッドとインターフェイスを表示する必要があります。

値シグネチャの規則は次のとおりです。

アクセシビリティの修飾子 (public、 internalなど) およびシグネチャにおける inline と mutable の修飾子は、実装の修飾子と一致している必要があります。
ジェネリック型パラメーターの数 (暗黙的に推定される、または明示的に宣言される) は一致している必要があります。また、ジェネリック型パラメーターの型と型制約は一致している必要があります。
Literal 属性を使用する場合、その属性はシグネチャと実装の両方に表示される必要があります。また、同じリテラル値を両方に使用する必要があります。
シグネチャと実装のパラメーターのパターン ( アリティとも呼ばれます) は、一致している必要があります。
シグネチャファイル内のパラメーター名が対応する実装ファイルと異なる場合は、シグネチャファイル内の名前が代わりに使用されます。これにより、デバッグまたはプロファイル時に問題が発生する可能性があります。このような不一致について通知されるようにするには、プロジェクトファイルで、またはコンパイラを呼び出す際に警告 3218 を有効にします (「コンパイラオプション」で --warnon を参照してください)。

次のコード例では、適切な属性と共に名前空間、モジュール、関数値、型シグネチャを持つシグネチャファイルの例を示します。また、対応する実装ファイルも示します。

// Module1.fsi

namespace Library1
  module Module1 =
    val function1 : int -> int
    type Type1 =
        new : unit -> Type1
        member method1 : unit -> unit
        member method2 : unit -> unit

    [<Sealed>]
    type Type2 =
        new : unit -> Type2
        member method1 : unit -> unit
        member method2 : unit -> unit

    [<Interface>]
    type InterfaceType1 =
        abstract member method1 : int -> int
        abstract member method2 : string -> unit

次のコードは実装ファイルを示します。

namespace Library1

module Module1 =

    let function1 x = x + 1


    type Type1() =
        member type1.method1() =
            printfn "type1.method1"
        member type1.method2() =
            printfn "type1.method2"


    [<Sealed>]
    type Type2() =
        member type2.method1() =
            printfn "type2.method1"
        member type2.method2() =
            printfn "type2.method2"

    [<Interface>]
    type InterfaceType1 =
        abstract member method1 : int -> int
        abstract member method2 : string -> unit

次の方法で共有

シグネチャ

解説

関連項目

その他のリソース