TypeName

FileHeaderMustHaveSummary

CheckId

SA1639

Category

Documentation Rules

Cause

The file header at the top of a C# code file does not contain a filled-in summary tag.

Rule Description

A violation of this rule occurs when the file header at the top of a C# file does not contain a valid summary tag. This rule is disabled by default.

For example:

//-----------------------------------------------------------------------

// <copyright file="Widget.cs" company="My Company">

//     Custom company copyright tag.

// </copyright>

//-----------------------------------------------------------------------

If this rule is enabled, the file header should contain a summary tag. For example:

//-----------------------------------------------------------------------

// <copyright file="Widget.cs" company="My Company">

//     Custom company copyright tag.

// </copyright>

// <summary>This is the Widget class.</summary>

//-----------------------------------------------------------------------

How to Fix Violations

To fix a violation of this rule, add and fill-in a summary tag describing the contents of the file.