C#の属性(Attribute)とは?使い方を解説
プログラミングを学習し始めた方なら、C#の属性を一度は目にしたことがあるかもしれません。ここでは「属性とはなに?」と疑問に思われている方に、C#の属性の概要とその使い方をわかりやすく説明していきたいと思います。
- プログラマー
- 属性について内容が難しくて理解が追いつかず、困っています。
- プロジェクト
リーダー - 属性の定義は難しいところがあります。ここでは、代表的な例も交えてお伝えしますね。
属性の定義とは?属性の概要と構文の解説
属性(Attribute)とは、クラス・構造体などの型、またはそのメンバー(メゾット・プロパティなど)に対して付与できる追加情報です。
属性を利用することで、本来のロジックと直接に関係ない付随的な情報を、ソースコードに追加できます。
PublicやPrivateもある意味属性
厳密にいうと属性と定義すると違うのでは?という意見もありますがイメージがしやすいため紹介させていただきます。
publicは「このメンバーはクラス外からも参照することが可能」という追加情報が当たれられ、privateは「このメンバーはクラス内だけ参照可能」という情報が付与されます。
属性の構文
属性はクラスやメンバーの前に[]でくくり記述します。
(例)
=============
1
2
|
[TestMethod]
Public void ShowTest(){…}
|
=============
このように記述を行うとメゾットに対してTestMethodでマークしておくことで、そのメゾットがテストメゾットであると認識することができます。
また、属性は複数設定することができます。 複数設定をする場合は改行を行い記述をしましょう。
(例)
=============
1
2
3
4
|
[Required]
[Index]
[MaxLength(150)]
Public stringUrl{get; set;}
|
=============
改行をすることによって綺麗に見やすい構文が完成します。
属性を使った例文
ここでは代表的な属性「Obsolete」を使った例文を紹介します。この属性を使用することによって該当のクラス、またはそのメンバーが旧型式(非推奨)であることをコンパイラーに通知できます。
プログラムを消すと問題が発生してしまうため残したい。ただ、旧型のプログラムのため今後ほかの人に使ってほしくない時にこの属性を使用しているとその旨を通知してくれるようになります。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
|
using System;
public class Program
{
//このメソッドを使用禁止、警告を出す
[Obsolete("代わりに 'second()' を使用します。")]
public static void first()
{
Console.WriteLine("first");
}
//このメソッドを使用禁止、エラーを出す
[Obsolete("'代わりに 'second()' を使用します。", true)]
public static void superfirst()
{
Console.WriteLine("superfirst");
}
public static void second()
{
Console.WriteLine("second");
}
//エントリポイント
public static void Main()
{
first();
superfirst();
}
}
|
この記述はfirstとsuperfirst を使用した際に警告が出るようになっています。
24
25
26
27
28
29
|
//エントリポイント
public static void Main()
{
first();
superfirst();
}
|
禁止されているのに使用されているため、画面では警告が出るようになっています。
このように「禁止されているものを誤って使った場合に警告を出す」というのをObsoleteという属性を記述することにより簡単にコントロールをすることができます。
- プログラマー
- PublicやPrivateであれば、いつも使っているから理解しやすいです!
- プロジェクト
リーダー - 厳密にいうと属性とはいえませんが、イメージとしてはつかみやすいと思います。これを機に属性の理解を深めていくと良いでしょう。
C#の属性は数多く存在する
今回お伝えしたことは属性の基本的なポイントのみになります。このほかにも標準の属性が沢山ありますし、属性を自作することも可能です。まずは、分かりやすいObsolete属性から勉強していき少しずつ属性を学んでいきましょう。
FEnet.NETナビ・.NETコラムは株式会社オープンアップシステムが運営しています。
株式会社オープンアップシステムはこんな会社です
秋葉原オフィスには株式会社オープンアップシステムをはじめグループのIT企業が集結!
数多くのエンジニアが集まります。
-
スマホアプリから業務系システムまで
スマホアプリから業務系システムまで開発案件多数。システムエンジニア・プログラマーとしての多彩なキャリアパスがあります。
-
充実した研修制度
毎年、IT技術のトレンドや社員の要望に合わせて、カリキュラムを刷新し展開しています。社内講師の丁寧なサポートを受けながら、自分のペースで学ぶことができます。
-
資格取得を応援
スキルアップしたい社員を応援するために資格取得一時金制度を設けています。受験料(実費)と合わせて資格レベルに合わせた最大10万円の一時金も支給しています。
-
東証プライム上場企業グループ
オープンアップシステムは東証プライム上場「株式会社夢真ビーネックスグループ」のグループ企業です。
安定した経営基盤とグループ間のスムーズな連携でコロナ禍でも安定した雇用を実現させています。
株式会社オープンアップシステムに興味を持った方へ
株式会社オープンアップシステムでは、開発系エンジニア・プログラマを募集しています。
年収をアップしたい!スキルアップしたい!大手の上流案件にチャレンジしたい!
まずは話だけでも聞いてみたい場合もOK。お気軽にご登録ください。
C#新着案件New Job
-
システム開発/東京都新宿区/【WEB面談可/C#経験者/20代前半の方活躍中/経験1年以上の方活躍中】/在宅勤務
月給29万~34万円東京都新宿区(新宿駅) -
システム開発/東京都新宿区/【WEB面談可/C#経験者/20代後半~40代の方活躍中/経験年数不問】/在宅勤務
月給41万~50万円東京都新宿区(新宿駅) -
デバック、テスト項目の作成/神奈川県横浜市/【WEB面談可/C#経験者/20代前半の方活躍中/経験1年以上の方活躍中】/在宅勤務
月給29万~34万円神奈川県横浜市(桜木町駅) -
デバック、テスト項目の作成/神奈川県横浜市/【WEB面談可/C#経験者/20代後半~40代の方活躍中/経験年数不問】/在宅勤務
月給41万~50万円神奈川県横浜市(桜木町駅) -
基幹システム開発導入/東京都新宿区/【WEB面談可/C#経験者/20代前半の方活躍中/経験1年以上の方活躍中】/在宅勤務
月給29万~34万円東京都新宿区(西新宿駅) -
基幹システム開発導入/東京都新宿区/【WEB面談可/C#経験者/20代後半~40代の方活躍中/経験年数不問】/在宅勤務
月給41万~50万円東京都新宿区(西新宿駅)