Battling some of the errors generated by Microsoft Source Analysis for C#
AssemblyInfo.cs
If you want to get rid of all the errors related to AssemblyInfo.cs and as a matter of fact any other autogenerate file use the autogenerated tag at the beginning of the file like so:
XML:
-
//<autogenerated />
How to format the file header
SA1633 calls for a valid header XML. If you are curious how to format the required file header here is an example:
XML:
-
// <copyright file="Program.cs" company="My Company">
-
// Copyright (c) Tobias Hertkorn. All rights reserved.
-
// </copyright>
Useful things to know–thanks for the post
Comment on May 26, 2008 @ 07:43:45
Need more of these … where can i find sample for documentation header….?
Comment on May 26, 2008 @ 12:29:58
@Sam: thanks.
@Avinash: I guess you mean the basic summary describing a method, property, etc. While using Visual Studio just type the slashes (///) above the method you want to document and the basic summary structure will appear.
More infos: http://www.codeproject.com/KB/XML/csharpcodedocumentation.aspx
Comment on May 26, 2008 @ 19:48:22