C# CS3021警告：CLSCompliant属性の設定と対処方法について解説
CS3021警告は、C#で発生するコンパイラ警告です。
アセンブリにCLSCompliant(true)が宣言されていない場合に、クラスへ[CLSCompliant(false)]属性が指定されると警告が表示されます。
不要な属性の記述が原因となるため、属性の削除やアセンブリレベルでの適切な設定の検討が求められます。
警告発生の背景
CLSCompliant属性とアセンブリ設定の基本
CLSCompliant 属性は、コードが共通言語仕様 (CLS: Common Language Specification) に準拠しているかどうかを示すために使用されます。
CLSに準拠することで、言語間での互換性が高まり、ライブラリやコンポーネントの再利用がしやすくなります。
通常、アセンブリ全体でこの属性を適用する場合は、AssemblyInfo.cs などに以下のように記述します。
using System;
// アセンブリ全体でCLS準拠とする設定
[assembly: CLSCompliant(true)]この設定により、アセンブリ内のすべての型はCLS準拠として扱われるため、個別に属性を指定する必要がなくなります。
警告が発生する状況
アセンブリでCLS準拠が宣言されていない場合、またはアセンブリレベルで CLSCompliant(true) が設定されていない状況で、クラスなどに [CLSCompliant(false)] を付加すると、CS3021警告が発生します。
これは、アセンブリ自体がCLS準拠でない状態にもかかわらず、特定の型だけ非準拠を明示しているため、矛盾が生じる場合に発生する警告です。
発生原因の詳細
アセンブリレベル設定不足による影響
CLS準拠の属性がアセンブリレベルで設定されていない場合、アセンブリ内の各型はデフォルトで非準拠と見なされます。
この状態で、クラスに対して [CLSCompliant(false)] を明示すると冗長であると判断され、コンパイラがCS3021警告を出力します。
この影響としては、警告メッセージが多数表示される可能性があり、プロジェクトのコンパイルログを見にくくする場合があります。
アセンブリでの宣言例と欠如例
以下の例は、アセンブリレベルに CLSCompliant(true) の宣言がない状態で、クラスに [CLSCompliant(false)] を適用した場合です。
using System;
// アセンブリ全体のCLS準拠宣言がない状態
[CLSCompliant(false)] // この属性の指定によりCS3021警告が発生します
public class SampleClass
{
public static void Main()
{
// サンプル実行コード
System.Console.WriteLine("警告発生サンプルコード");
}
}上記のコードでは、アセンブリレベルの設定がないため、SampleClass に付与された [CLSCompliant(false)] は不要とされ、警告が出力されます。
クラス単位の属性設定の誤用
クラス単位で CLSCompliant 属性を指定する場合、アセンブリがCLS準拠として宣言されていないと、その属性の意味が薄れてしまいます。
特に、意図的に非準拠を示すために [CLSCompliant(false)] を使用する際は、アセンブリ全体がCLS準拠であると明言した上で個別に例外を示す場合にのみ有効です。
[CLSCompliant(false)]の使用例
以下の例は、アセンブリ全体がCLS準拠である中で、特定のクラスだけ非準拠とする場合の正しい使用例です。
using System;
[assembly: CLSCompliant(true)] // アセンブリ全体でCLS準拠として宣言
[CLSCompliant(false)] // このクラスのみ非準拠として扱う
public class NonCompliantClass
{
public static void Main()
{
System.Console.WriteLine("非CLS準拠のクラス実行");
}
}この設定により、アセンブリはCLS準拠と宣言されるため、NonCompliantClass に対する非準拠の明示が意味を持ち、警告が発生しません。
対処方法
アセンブリレベルでの対策
CLSCompliant属性によるCS3021警告を解消するための一つの方法は、アセンブリレベルでCLS準拠として宣言する方法です。
アセンブリ全体に対して CLSCompliant(true) を追加すれば、個別に [CLSCompliant(false)] を指定する必要がなくなり、警告を回避できます。
[CLSCompliant(true)]の設定方法
AssemblyInfo.cs やソースコードの先頭に以下のように記述します。
using System;
// アセンブリ全体でCLS準拠を宣言する例
[assembly: CLSCompliant(true)]
public class CompliantClass
{
public static void Main()
{
System.Console.WriteLine("CLS準拠のクラス実行");
}
}このようにすることで、アセンブリがCLS準拠として扱われ、個別に属性を付与する必要がなくなります。
クラス属性設定の修正
アセンブリレベルでCLS準拠を宣言できない、または宣言したくない場合は、個別のクラスに付与された [CLSCompliant(false)] を削除することが警告解消の一つの方法です。
ただし、意図的に非準拠の動作を示している場合は、アセンブリ全体をCLS準拠とする方針に合わせるか、クラス単位での記述の見直しが必要になります。
属性削除時の注意点
属性を削除する際は、対象クラスが他のCLS準拠の型と相互運用可能であることを十分に確認する必要があります。
たとえば、他言語から利用することを考慮した設計なら、CLS準拠は重要な要素となりますので、単に属性を削除するのではなく、全体の設計方針を再検討してください。
コード例の解説
警告発生サンプルコード
以下は、アセンブリレベルの設定が不足している場合にCS3021警告が発生するサンプルコードです。
修正前と修正後の比較
修正前
using System;
// アセンブリレベルでのCLS準拠宣言がなく、警告が発生する例
[CLSCompliant(false)] // CS3021警告発生箇所
public class WarningClass
{
public static void Main()
{
// コンパイラ警告の原因となるコード例
System.Console.WriteLine("警告発生サンプルコード");
}
}警告: CS3021 - アセンブリに CLSCompliant 属性が含まれていないため、'WarningClass' には CLSCompliant 属性が必要ありません修正後
using System;
// アセンブリレベルでCLS準拠を宣言することで警告解消
[assembly: CLSCompliant(true)]
[CLSCompliant(false)] // 特定のクラスのみ非CLS準拠として明示
public class FixedClass
{
public static void Main()
{
// 警告が解消された正しいコード例
System.Console.WriteLine("警告解消サンプルコード");
}
}警告解消サンプルコードまとめ
この記事では、CLSCompliant属性の基本的な役割とアセンブリレベルでの設定方法、さらにはクラス単位での属性設定が警告CS3021を引き起こす原因について解説しています。
アセンブリ全体に対してCLSCompliant(true)を宣言することの重要性と、不要な属性指定を避ける方法をサンプルコードとともに説明し、正しい対処方法を明確に示しました。