[C#] 剖析 AssemblyInfo.cs – 了然常用的特点 Attribute

浅析 AssemblyInfo.cs – 通晓常用的风味 Attribute

【博主】反骨仔    【原文】http://www.cnblogs.com/liqingwen/p/5944391.html

 

C# 1

  

  在此之前,我们通过《C# 知识回顾 – 特性
Attribute
》已经理解怎么创制和行使特性
Attribute,这一次,让大家联合来探视每一回使用 VS
创设项目时所自带的文件 AssemblyInfo.cs。

 

目录

 

AssemblyInfo.cs

C# 2

擅自挑选一个 AssemblyInfo.cs 文件,展开图中的代码,看箭头↓

using System.Reflection;
using System.Runtime.InteropServices;

// 有关程序集的常规信息通过下列特性集
// 控制。更改这些特性值可修改
// 与程序集关联的信息。
[assembly: AssemblyTitle("MusicStore")]
[assembly: AssemblyDescription("")]
[assembly: AssemblyConfiguration("")]
[assembly: AssemblyCompany("Microsoft")]
[assembly: AssemblyProduct("MusicStore")]
[assembly: AssemblyCopyright("Copyright © Microsoft 2016")]
[assembly: AssemblyTrademark("")]
[assembly: AssemblyCulture("")]

// 将 ComVisible 设置为 false 会使此程序集中的类型
// 对 COM 组件不可见。如果需要
// 从 COM 访问此程序集中的某个类型,请针对该类型将 ComVisible 特性设置为 true。
[assembly: ComVisible(false)]

// 如果此项目向 COM 公开,则下列 GUID 用于 typelib 的 ID
[assembly: Guid("a9ef3281-9049-4a52-a2f1-2061d442200e")]

// 程序集的版本信息由下列四个值组成:
//
//      主版本
//      次版本
//      内部版本号
//      修订版本
//
// 可以指定所有值,也可以使用“修订号”和“内部版本号”的默认值,
// 方法是按如下所示使用 "*":
[assembly: AssemblyVersion("1.0.0.0")]
[assembly: AssemblyFileVersion("1.0.0.0")]

 

一、全局特性

  大多数表征适用于特定的言语元素(如类或方法),不过,有种特性它们适用于任何程序集或模块,称为全局特性。如:AssemblyVersionAttribute 特性可用于向程序集中停放版本音讯。

C# 3

 

  全局特性在源代码中出现在此外顶级 using 指令以及另外项目、模块或命名空间表明往日。全局特性可体现在七个源文件,然而,在单一编译传递必须编译文件。在
C# 项目中,它们在 AssemblyInfo.cs 文件中。

  程序集特性是提供关于程序集的音讯的值。它们分成以下项目:

    ①顺序集标识特性

    ②新闻性特性

    ③程序集清单特性

    ④强名称特性

  

  1.主次集标识特性

  五个特征 (使用强名称,假诺适用)
确定程序集的标识:名称、版本和区域性。当在代码中援引时,这一个特点构成程序集的完全名称需要。使用特性,能够将先后集的本子、区域性和名称值,由编译器,在 “程序集音信”对话框 的
Visual Studio IDE
设置,在创设程序集后,按照包含程序集清单的文件。AssemblyFlagsAttribute 特性指定程序集的多少个副本是否足以存活。

C# 4

 

C# 5

图 – “程序集音讯”对话框

C# 6

图 – “程序集信息”对话框中的名词和 AssemblyInfo.cs 文件的照应关系

 

  2.消息性特性

  您可以选用音信性特性为顺序集提供其他的商号或产品信息。

C# 7

 

  3.先后集清单特性

  可以利用程序集清单特性提供程序集清单中的信息。其中囊括标题、表达、默认别名和配备。

C# 8

 

  4.强称呼特性(不深切)

  一般设有 Visual Studio
的前期版本,若要使用强名称的次第集执行以下顺序集级别特性:

    ①AssemblyKeyFileAttribute

    ②AssemblyKeyNameAttribute

    ③AssemblyDelaySignAttribute

  即便现在仍襄助,不过,给程序集签名的首选办法是采纳“签名页”。(这里不深远驾驭)

 

二、已不合时宜的特点:Obsolete

   Obsolete 特性指示某个程序实体标记为提议不再行使的一个。
每一趟使用对实体标记为过时依据随后将生成警告或错误。

 1     /// <summary>
 2     /// 旧类
 3     /// </summary>
 4     [Obsolete("请使用 " + nameof(NewClass))]
 5     class OldClass
 6     {
 7         public void Method() { }
 8     }
 9 
10     /// <summary>
11     /// 新类
12     /// </summary>
13     class NewClass
14     {
15         [Obsolete("请使用 " + nameof(NewMethod), true)]
16         public void OldMethod() { }
17 
18         public void NewMethod() { }
19     }

 1     class Program
 2     {
 3         static void Main(string[] args)
 4         {
 5             var oldClass = new OldClass();  //警告
 6 
 7             var newClass = new NewClass();
 8             newClass.OldMethod();  //报错
 9         }
10     }

C# 9

  在此示例中应用 Obsolete 特性类 OldClass 和方法
NewClass.OldMethod。此构造函数的率先个参数为警告或不当的信息,由于特性构造函数的第二个参数被使用于
NewClass.OldMethod 设置为 true,此模式将导致编译器错误,而使用 OldClass 只将生成警告的类。

 

三、条件特性:Conditional

Conditional 特性执行形式倚重于预处理标识符。Conditional 属性是 ConditionalAttribute 的别名,可采纳于艺术或属性类。

  在此示例中,Conditional 应用于方法以启用或剥夺程序一定诊断信息示:

 1     class Debug
 2     {
 3         [Conditional("DEBUG")]
 4         public static void Output(string msg)
 5         {
 6             Console.WriteLine(msg);
 7         }
 8     }
 9 
10     class Program
11     {
12         static void Main(string[] args)
13         {
14             Debug.Output("This is Debug!");
15             Console.WriteLine("Done!");
16 
17             Console.Read();
18         }
19     }

  Conditional 特性平时用于在 DEBUG 标识符启用跟踪,并记录的法力的调节版本,但不在发表版本中。

C# 10

  

  将事先的代码简单改动下,使用 #if…#endif 包扎,结果和上图是均等的。

    class Debug
    {
        public static void Output(string msg)
        {
            Console.WriteLine(msg);
        }
    }

    class Program
    {
        static void Main(string[] args)
        {
            #if DEBUG
            Debug.Output("This is Debug!");
            #endif

            Console.WriteLine("Done!");

            Console.Read();
        }
    }

  使用 Conditional 更加整洁,当然也足以将平日不太到用到或者容易出错的法子在 #if…#endif 内部块标明。

C# 11

 

四、调用方信息特性

  使用调用方信息属性,可以获取有关调用方的消息传递给艺术。可以收获源代码、行号在源代码和调用方的积极分子名称的公文路径。

  若要获取成员调用方消息,请使用适用于可选参数的特性。每个可选参数指定默认值。

C# 12

 

 1     internal class Program
 2     {
 3         private static void Main(string[] args)
 4         {
 5             CallerMethod();
 6             Console.Read();
 7         }
 8 
 9         public static void CallerMethod()
10         {
11             TraceMessage("我是调用者");
12         }
13 
14         public static void TraceMessage(string msg,
15             [CallerMemberName] string name = "",
16             [CallerFilePath] string filePath = "",
17             [CallerLineNumber] int lineNumer = 0)
18         {
19             Trace.WriteLine($"{nameof(msg)}: {msg}");
20             Trace.WriteLine($"{nameof(name)}: {name}");
21             Trace.WriteLine($"{nameof(filePath)}: {filePath}");
22             Trace.WriteLine($"{nameof(lineNumer)}: {lineNumer}");
23         }
24     }

C# 13

  每一遍调用 CallerMethod 方法时,调用方音信将替换为可选参数的变量。

 

  1.备注

  你必须为各类可选参数指定显式默认值。无法将调用方音讯特性应用于未指定为可选的参数。

  调用方音讯特性不会使参数成为可选参数。相反,它们会在不经意此参数时影响传播的默认值。

  在编译时,调用方音信值将作为文本传入中间语言
(IL)。与特其余 StackTraceC#, 特性的结果不同,那么些结果不受模糊处理的熏陶。

  你可显式提供可选参数来支配调用方消息或隐藏调用方音信。

 

传送门

  《C# 知识回顾 – 特性
Attribute

  《C# 知识回顾 –
系列化

  《C# 知识回顾 – 表明式树 Expression
Trees

 

 


【参考】微软官方文档

 

相关文章