レベル1

C# コンパイラ警告 CS1695 の原因と対策について解説

2025-03-29更新日: 2025-03-29

CS1695は、C#のコンパイラ警告で、無効な#pragma checksum構文が原因で発生します。

正しい書式は

#pragma checksum “filename” “{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}” “checksum”

の形で、GUIDやチェックサムが16進数かつ所定の桁数である必要があります。

入力ミスにより誤った形式になった場合に警告され、Code Dom APIでコードを生成する場合は通常問題になりません。

目次から探す

警告の背景と原因
- #pragma checksum 構文の基本的役割
- CS1695 警告が発生する要因
正しい #pragma checksum の記述方法
- 書式の詳細と規定
- 16進数表記と桁数の要件
誤った記述による警告発生例
- 入力ミスによるエラー事例
- CodeDom API 利用時の注意点
エラー解消の対策
- 修正方法の検討
- 開発環境での確認方法
まとめ

警告の背景と原因

#pragma checksum 構文の基本的役割

#pragma checksum は、デバッガーがソースコードとバイナリの対応関係を正しく追跡するために用いられる命令です。

この命令は、対象となるファイル名、GUID、チェックサムといった3つの情報を組み合わせることで、ソースファイルの正当性と一貫性を確認する役割を果たします。

たとえば、ソースコードが変更された場合、チェックサムの値が変化するため、古い情報を読み込むことを防止する仕組みとして動作します。

CS1695 警告が発生する要因

CS1695 警告は、#pragma checksum の構文に誤りがある場合に発生します。

警告の原因としては、以下の点が考えられます。

ファイル名、GUID、チェックサムのいずれかの要素が省略または不正な形式である
GUID の部分が正しい桁数やデリミタ(ハイフン)の形式に従っていない
チェックサムの値が偶数桁数に満たない、または数値が 16 進数表記となっていない

これらの要因が組み合わさることで、コンパイラが構文エラーとして判断し、CS1695 警告が表示されることになります。

正しい #pragma checksum の記述方法

書式の詳細と規定

正しい #pragma checksum の書式は次のようになっています。

#pragma checksum "filename" "{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}" "XXXX…"

この書式に従う必要があり、各パラメータの記述に誤りがあると CS1695 警告が発生します。

ファイル名の指定規則

ファイル名は、ダブルクォーテーションで囲まれる必要があります。

たとえば、ファイル名を指定する部分は次のように記述します。

#pragma checksum "C:\\MyProject\\Test.cs" "{...}" "..."

ディレクトリ区切り記号やスペルミスに注意して、正確に記述することが求められます。

GUID の形式と条件

GUID の指定は必ずダブルクォーテーション内に記述し、波括弧 {} で囲んだ形式で入力する必要があります。

GUID は $8 - 4 - 4 - 4 - 12$ の桁数の16進数で入力するルールがあり、例えば次のように指定します。

"{12345678-1234-1234-1234-1234567890AB}"

各ブロックの桁数やデリミタ(ハイフン)に誤りがないか確認する必要があります。

チェックサムの記述ルール

チェックサムは、ソースコードの内容に基づいたハッシュ値であり、16進数表記で偶数の桁数で記述する必要があります。

正しいチェックサム例は以下のようになります。

"AB12CD34EF56"

チェックサムの桁数が奇数になったり、16進数以外の文字が含まれている場合は、エラーの原因となります。

16進数表記と桁数の要件

GUID およびチェックサムの両方において、16進数表記が必須です。

GUID の各セクションは、定められた桁数で入力されなければならず、チェックサムもまた偶数桁で記述する必要があります。

たとえば、GUID 部分では

$X X X X X X X X - X X X X - X X X X - X X X X - X X X X X X X X X X X X$

という形式が求められ、チェックサムでは桁数が偶数であることに注意が必要です。

誤った記述による警告発生例

入力ミスによるエラー事例

入力ミスによるエラーの例として、ファイル名や GUID、チェックサムのいずれかが正しい形式で記述されていない場合を挙げることができます。

下記の例は、ファイル名として "12345" だけが記述され、GUID やチェックサムが欠落しているため、CS1695 警告が発生するケースです。

// CS1695_ErrorExample.cs
#pragma checksum "12345"  // CS1695 エラーが発生するコード例
public class Test
{
    public static void Main()
    {
        // 実行時には何もしません。
    }
}

CS1695: 無効な #pragma checksum 構文です。有効な #pragma checksum は、"filename" "{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}" "XXXX…" です

CodeDom API 利用時の注意点

CodeDom API を利用してコードを自動生成する場合、通常は実行時に適切なチェックサムが挿入されるため、CS1695 警告が発生することはほとんどありません。

しかし、生成されたコードに対して手動で #pragma checksum を追加する際、以下の点に注意する必要があります。

自動生成された部分と手動で追加する部分の書式が混在しないか
GUID やチェックサムの形式が自動生成されるコードと一致しているか

これらの確認を怠ると、予期せぬ CS1695 警告が表示される場合があります。

エラー解消の対策

修正方法の検討

入力時の注意点

#pragma checksum の記述修正を行う際は、以下の点に注意してください。

各要素(ファイル名、GUID、チェックサム)が必ずダブルクォーテーションで囲まれているか確認する
GUID 内の桁数とハイフンの配置が正しいか検証する
チェックサムが偶数桁かつ 16 進数表記であるかどうかを確認する

これらのポイントをチェックすることで、入力ミスによるエラーを防ぐことができます。

既存コード修正のポイント

既存のソースコードに対して修正を施す場合は、以下の手順を参考にしてください。

問題が発生している #pragma checksum の行を特定する
上記の正しい書式に基づいて、内容を一つひとつ確認する
自動生成されたコードと手動修正の部分で混在した記述がないか検証する

この手順に沿って進めることで、エラー原因の特定と修正が容易になります。

開発環境での確認方法

開発環境においてエラーの有無を確認する際は、コンパイル時の出力メッセージや警告リストを確認してください。

Visual Studio やその他の IDE では、エラー箇所を直接ハイライト表示する機能があるため、以下の点に注意してください。

指摘された #pragma checksum 行が正しい書式に沿っているか確認する
エラーリスト内の情報をもとに、ファイル、GUID、チェックサムそれぞれの指定内容を検証する

これにより、問題箇所の迅速な特定と修正が可能になります。

まとめ

この記事では、#pragma checksum の基本的な役割とCS1695 警告の発生原因について解説しています。

正しい書式やGUID、チェックサムの記述ルール、16進数表記の要件を理解し、入力ミスやCodeDom API利用時の注意点を把握することで、エラー発生時の具体的な修正方法と確認手順を学ぶことができます。

これにより、正確な記述を心掛け、コンパイラ警告を未然に防ぐ手法を実践できます。