Suppress StyleCop SA1600

- 
 
 

Local Suppression:

[SuppressMessage("Microsoft.StyleCop.CSharp.DocumentationRules", 
"SA1600:ElementsMustBeDocumented", Justification = "Reviewed. 
Suppression is OK here.")]

for local suppression you must use namespace 
using System.Diagnostics.CodeAnalysis;
 
OR
you can also use
 
[System.Diagnostics.CodeAnalysis.SuppressMessage
("Microsoft.StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]

 Example: 

using System.Diagnostics.CodeAnalysis; 

[SuppressMessage("Microsoft.StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented", Justification = "Reviewed. Suppression is OK here.")] 

protected void Button1_Click(object sender, EventArgs e) 
{ 
}

[SuppressMessage("Microsoft.StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented", Justification = "Reviewed. Suppression is OK here.")] 

protected void Button2_Click(object sender, EventArgs e) 
{ 
}


Global Suppression:

[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage
("Microsoft.StyleCop.CSharp.DocumentationRules", 
"SA1600:ElementsMustBeDocumented", Justification = "Reviewed. 
Suppression is OK here.")]
 
 

Example: 

 [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage
("Microsoft.StyleCop.CSharp.DocumentationRules",
 "SA1600:ElementsMustBeDocumented",
 Justification = "Reviewed. Suppression is OK here.")]
 protected void Button1_Click(object sender, EventArgs e) 
 { 
 } 
protected void Button2_Click(object sender, EventArgs e)  
{ 
 }  


 

Comments

Post a Comment

Popular posts from this blog

C# Copy files from one server to another

-
Sometimes we need to copy files from one sever and paste those files to another server programmatically. So for that we can use below code but we should have admin credentials of that server where we want to paste files. In below method we need to pass source path of the server, from where we want to copy and destination path of the server, where we want to paste. Also we need to provide UserName, Domain, Password of the server where we want to paste those files. public void CopyFiles(string sourcePath, string destinationPath)         {             try             {                  IntPtr admin_token = new IntPtr();                 // use LOGON32_LOGON_NEW_CREDENTIALS as Lo...
Read more

Export SharePoint Online Group Users to Excel using Powershell

-
Sometimes, we have a requirement to generate user reports from SharePoint groups or validate which user is added to which groups etc. If we do this activity manually, it may take forever (obviously based on the user added to group 😉).  Classic example, recently in my project i got a requirement where i need to find all the users who are added to multiple SharePoint groups. Now i have 2500 users added to my SP Groups and it is difficult to check one by one. So i generated CSV/Excel for each group and added a vlookup in excel and got my report. Below is the Powershell script, which helps to generate CSV file based on group name.  Note: All the input variables are mentioned in Green Color, Please update before executing this script. $aClient = [ System.Reflection.Assembly ]:: LoadWithPartialName( "Microsoft.SharePoint.Client" ) $aClientRuntime = [ System.Reflection.Assembly ]:: LoadWithPartialName( "Microsoft.SharePoint.Client.Runtime" )   Function Get-UserInfo...
Read more