Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

'AssemblyTitle' attribute in the .NET Framework

Tags:

What is the practical use of the AssemblyTitle attribute? MSDN says that it specifies a description for an assembly and that the assembly title is a friendly name which can include spaces.

Visual Studio asks for the assembly name in the properties window of the project along with the default namespace. There is an AssemblyName attribute but it describes an assembly's unique identity in full (i.e., culture, etc.). I don't see how AssemblyTitle differs from AssemblyProduct.

I used the IL Disassembler to see how Microsoft uses AssemblyTitle. I discovered that in mscorlib.dll, AssemblyTitle, AssemblyProduct and AssemblyDefaultAlias are all set to "mscorlib.dll".

In conclusion, what I really would like to see are practical examples of the use of AssemblyTitle.

like image 364
HelloWorld Avatar asked Apr 17 '14 23:04

HelloWorld


People also ask

What are assembly attributes?

Assembly attributes are values that provide information about an assembly. The attributes are divided into the following sets of information: Assembly identity attributes. Informational attributes.

How do I add attributes to assembly level?

Apply attributes at the assembly levelWhen this attribute is applied, the string "My Assembly" is placed in the assembly manifest in the metadata portion of the file. You can view the attribute either by using the MSIL Disassembler (Ildasm.exe) or by creating a custom program to retrieve the attribute.

What are the different types of assemblies?

There are three types of assemblies: Private assemblies. Shared assemblies. Satellite assemblies.

What is assembly identity?

Identity. An assembly's identity includes its simple name (also called its weak name), a version number, an optional culture if the assembly contains localized resources, and an optional public key used to guarantee name uniqueness and to "protect" the name from unwanted reuse. Contents.


1 Answers

[AssemblyTitle] is a pretty big deal, it is directly visible when you right-click on the assembly and use Properties + Details.

An example to make it more visible. Let's start with this AssemblyInfo.cs file:

[assembly: AssemblyTitle("AssemblyTitle")] [assembly: AssemblyDescription("AssemblyDescription")] [assembly: AssemblyConfiguration("AssemblyConfiguration")] [assembly: AssemblyCompany("AssemblyCompany")] [assembly: AssemblyProduct("AssemblyProduct")] [assembly: AssemblyCopyright("AssemblyCopyright")] [assembly: AssemblyTrademark("AssemblyTrademark")] [assembly: AssemblyCulture("")] [assembly: Guid("7da36bdf-39fb-4a4d-b98c-ecefd99b155a")] [assembly: AssemblyVersion("1.2.3.4")] [assembly: AssemblyFileVersion("5.6.7.8")] 

And look at the properties of the file:

enter image description here

Some annotations to this:

  • Note how [AssemblyDescription] is misleading, it is actually the Title you see in the property sheet.
  • Description, Configuration and Company are not displayed. You probably want to merge the company name into the visible Copyright. Description and Company are actually present in the unmanaged version resource but Windows just doesn't display it.
  • [AssemblyCulture] is special, it is used by satellite assemblies for localization
  • [Guid] is special, it sets the type library guid if you create a [ComVisible] assembly
  • [AssemblyVersion] is extraordinary special, a really big deal in the .NET Framework. That it is not displayed is a major hangup. You can see it in XP, not in later Windows versions. A strong consideration is to make the [AssemblyFileVersion] the same value.
  • The displayed "Product version" is the same as the "File version". That's not great either, you want to add the [AssemblyInformationalVersion] attribute to fix that.

It is quirky, the Windows group and DevDiv didn't always work together well.

like image 101
Hans Passant Avatar answered Oct 08 '22 17:10

Hans Passant