This document describes rules and recommendations for developing applications and class libraries using the C# Language. The goal is to define guidelines to enforce consistent style and formatting and help developers avoid common pitfalls and mistakes. Specifically, this document covers Naming Conventions, Coding Style, Language Usage, and Object Model Design.
class CustomerConfiguration : IEntityTypeConfiguration<Customer>
{
public void Configure(EntityTypeBuilder<Customer> builder)
{
builder.HasKey(c => c.AlternateKey);
builder.Property(c => c.Name).HasMaxLength(200);
}
}
...
// OnModelCreating
builder.ApplyConfiguration(new CustomerConfiguration()); 
// Post
public int Id { get; set; }
public string Title { get; set; }
public int LikeCount { get; set; }
public int CommentCount { get; set; }
public DateTimeOffset DateCreated { get; set; } = DateTimeOffset.UtcNow; services.AddScoped<SieveProcessor>();
۱.۳. از طریق اضافه کردن صفت (Attribute) به ویژگی‌ها
// Post
public int Id { get; set; }
[Sieve(CanFilter = true, CanSort = true)]
public string Title { get; set; }
[Sieve(CanFilter = true, CanSort = true)]
public int LikeCount { get; set; }
[Sieve(CanFilter = true, CanSort = true)]
public int CommentCount { get; set; }
[Sieve(CanFilter = true, CanSort = true, Name = "created")]
public DateTimeOffset DateCreated { get; set; } = DateTimeOffset.UtcNow; ۲.۳. از طریق Fluent API
برای استفاده از این روش، ابتدا کلاسی را ایجاد و از کلاس SieveProcessor مشتق کنید. سپس تابع MapProperties موجود در کلاس والد را override کنید.// ApplicationSieveProcessor
public class ApplicationSieveProcessor : SieveProcessor
{
public ApplicationSieveProcessor(
IOptions<SieveOptions> options,
ISieveCustomSortMethods customSortMethods,
ISieveCustomFilterMethods customFilterMethods)
: base(options, customSortMethods, customFilterMethods)
{
}
protected override SievePropertyMapper MapProperties(SievePropertyMapper mapper)
{
mapper.Property<Post>(p => p.Title)
.CanFilter()
.HasName("a_different_query_name_here");
mapper.Property<Post>(p => p.CommentCount)
.CanSort();
mapper.Property<Post>(p => p.DateCreated)
.CanSort()
.CanFilter()
.HasName("created_on");
return mapper;
}
} services.AddScoped<ISieveProcessor, ApplicationSieveProcessor>();
[HttpGet]
public JsonResult GetPosts(SieveModel sieveModel)
{
var result = _dbContext.Posts;
result = _sieveProcessor.Apply(sieveModel, result);
return Json(result.ToList());
} GET /GetPosts ?sorts= LikeCount,CommentCount,-created // sort by likes, then comments, then descendingly by date created &filters= LikeCount>10,Title@=awesome title, // filter to posts with more than 10 likes, and a title that contains the phrase "awesome title" &page= 1 // get the first page... &pageSize= 10 // ...which contains 10 posts
| عملگر | توضیحات | عملگر | توضیحات |
| == | برابر | =@ | شامل |
| =! | مخالف | =_ | شروع شود با |
| < | بزرگ‌تر | *=@ | شامل (حساس به حروف)* |
| > | کوچک‌تر | *=_ | شروع شود با (حساس به حروف) |
| =< | بزرگ‌تر مساوی | *== | برابر (حساس به حروف) |
| => | کوچک‌تر مساوی | |
{
"Sieve": {
"CaseSensitive": "boolean: should property names be case-sensitive? Defaults to false",
"DefaultPageSize": "int number: optional number to fallback to when no page argument is given. Set <=0 to disable paging if no pageSize is specified (default).",
"MaxPageSize": "int number: maximum allowed page size. Set <=0 to make infinite (default)",
"ThrowExceptions": "boolean: should Sieve throw exceptions instead of silently failing? Defaults to false"
}
} services.Configure<SieveOptions>(Configuration.GetSection("Sieve")); mkdir ps_cmdlet_with_csharp && cd "$_" dotnet new classlib dotnet add package PowerShellStandard.Library mv Class1.cs GetHelloCommand.cs
namespace ps_cmdlet_with_csharp;
using System.Management.Automation;
[Cmdlet(VerbsCommon.Get, "Hello")]
public class GetHelloCommand : PSCmdlet
{
[Parameter(Mandatory = true, Position = 0, ValueFromPipeline = true)]
public string Name { get; set; }
protected override void BeginProcessing()
{
WriteObject("Start processing");
}
protected override void ProcessRecord()
{
WriteObject("Hello " + Name);
}
protected override void EndProcessing()
{
WriteObject("End processing");
}
} using System.Collections.ObjectModel;
using System.Management.Automation.Host;
namespace System.Management.Automation
{
public abstract class PSCmdlet : Cmdlet
{
protected PSCmdlet();
public PSEventManager Events { get; }
public PSHost Host { get; }
public CommandInvocationIntrinsics InvokeCommand { get; }
public ProviderIntrinsics InvokeProvider { get; }
public JobManager JobManager { get; }
public JobRepository JobRepository { get; }
public InvocationInfo MyInvocation { get; }
public PagingParameters PagingParameters { get; }
public string ParameterSetName { get; }
public SessionState SessionState { get; }
public PathInfo CurrentProviderLocation(string providerId);
public Collection<string> GetResolvedProviderPathFromPSPath(string path, out ProviderInfo provider);
public string GetUnresolvedProviderPathFromPSPath(string path);
public object GetVariableValue(string name);
public object GetVariableValue(string name, object defaultValue);
}
} PS /> dotnet build PS /> Import-Module ./bin/Debug/net7.0/ps_cmdlet_with_csharp.dll
PS /> Get-Command -Module ps_cmdlet_with_csharp CommandType Name Version Source ----------- ---- ------- ------ Cmdlet Get-Hello 1.0.0.0 ps_cmdlet_with_csharp
namespace ps_cmdlet_with_csharp;
using System.Management.Automation;
[Cmdlet(VerbsCommon.Get, "Hello")]
public class GetHelloCommand : PSCmdlet
{
// as before
}
[Cmdlet(VerbsCommon.Get, "Greetings")]
public class GetGreetingsCommand : PSCmdlet
{
[Parameter(Mandatory = true, Position = 0, ValueFromPipeline = true)]
public string Name { get; set; }
protected override void BeginProcessing()
{
WriteObject("Start processing");
}
protected override void ProcessRecord()
{
WriteObject("Greetings " + Name);
}
protected override void EndProcessing()
{
WriteObject("End processing");
}
} Import-Module: Invalid assembly public key.
<Project Sdk="Microsoft.NET.Sdk">
<!-- other tags -->
<ItemGroup>
<Compile Include="./GetHelloCommand.cs" />
</ItemGroup>
</Project> PS /> Get-Command -Module ps_cmdlet_with_csharp CommandType Name Version Source ----------- ---- ------- ------ Cmdlet Get-Greetings 1.0.0.0 ps_cmdlet_with_csharp Cmdlet Get-Hello 1.0.0.0 ps_cmdlet_with_csharp
namespace ps_cmdlet_with_csharp;
using System.Management.Automation;
using System.Net.Http.Headers;
[Cmdlet(VerbsCommon.Push, "SlackMessage")]
[Alias("ssm")]
[OutputType(typeof(string))]
public class SlackMessageCommand : PSCmdlet
{
[Parameter(Mandatory = true)]
[Alias("m")]
public string Message { get; set; }
[Parameter(Mandatory = true)]
[Alias("t")]
[ValidatePattern(@"xoxp-[0-9]{11}-[0-9]{12}-[0-9]{13}-[0-9a-zA-Z]{32}")]
public string Token { get; set; }
[Parameter(Mandatory = true)]
[Alias("cid")]
public string ChannelID { get; set; }
protected async override void ProcessRecord()
{
base.ProcessRecord();
try
{
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", this.Token);
var values = new Dictionary<string, string>
{
{ "channel", this.ChannelID },
{ "text", this.Message }
};
var content = new FormUrlEncodedContent(values);
var response = await client.PostAsync("https://slack.com/api/chat.postMessage", content);
var responseString = await response.Content.ReadAsStringAsync();
WriteObject("Message sent");
}
catch (Exception ex)
{
WriteObject(ex.Message);
}
}
} PS /> $PROFILE | Get-Member -Type NoteProperty | Select-Object Name, Definitionbject Name, Definition Name Definition ---- ---------- AllUsersAllHosts string AllUsersAllHosts=/usr/local/microsoft/powershell/7/… AllUsersCurrentHost string AllUsersCurrentHost=/usr/local/microsoft/powershell… CurrentUserAllHosts string CurrentUserAllHosts=/Users/sirwanafifi/.config/powe… CurrentUserCurrentHost string CurrentUserCurrentHost=/Users/sirwanafifi/.config/p…
$SlackProjectPath = "/Users/sirwanafifi/Desktop/ps_cmdlet_with_csharp/bin/Debug/net7.0/ps_cmdlet_with_csharp.dll" Import-Module $SlackProjectPath
PS /> Get-Command -Module ps_cmdlet_with_csharp CommandType Name Version Source ----------- ---- ------- ---- Cmdlet Push-SlackMessage 1.0.0.0 ps_…
using System;
using System.Linq;
using System.Collections.Generic;
using System.IO;
using System.Web.Mvc;
namespace SecurityModule
{
[AttributeUsage(AttributeTargets.Method, AllowMultiple = false)]
public sealed class AllowUploadSafeFilesAttribute : ActionFilterAttribute
{
static readonly IList<string> ExtToFilter = new List<string> {
".aspx", ".asax", ".asp", ".ashx", ".asmx", ".axd", ".master", ".svc", ".php" ,
".php3" , ".php4", ".ph3", ".ph4", ".php4", ".ph5", ".sphp", ".cfm", ".ps", ".stm",
".htaccess", ".htpasswd", ".php5", ".phtml", ".cgi", ".pl", ".plx", ".py", ".rb", ".sh", ".jsp",
".cshtml", ".vbhtml", ".swf" , ".xap", ".asptxt"
};
static readonly IList<string> NameToFilter = new List<string> {
"web.config" , "htaccess" , "htpasswd", "web~1.con"
};
static bool canUpload(string fileName)
{
if (string.IsNullOrWhiteSpace(fileName))
return false;
fileName = fileName.ToLowerInvariant();
var name = Path.GetFileName(fileName);
var ext = Path.GetExtension(fileName);
if (string.IsNullOrWhiteSpace(name))
throw new InvalidOperationException("Uploaded file should have a name.");
return !ExtToFilter.Contains(ext) &&
!NameToFilter.Contains(name) &&
!NameToFilter.Contains(ext) &&
//for "file.asp;.jpg" files
ExtToFilter.All(item => !name.Contains(item));
}
public override void OnActionExecuting(ActionExecutingContext filterContext)
{
var files = filterContext.HttpContext.Request.Files;
foreach (string file in files)
{
var postedFile = files[file];
if (postedFile == null || postedFile.ContentLength == 0) continue;
if (!canUpload(postedFile.FileName))
throw new InvalidOperationException(string.Format("You are not allowed to upload {0} file.", Path.GetFileName(postedFile.FileName)));
}
base.OnActionExecuting(filterContext);
}
}
}
[AllowUploadSafeFiles] public ActionResult UploadFile(HttpPostedFileBase file)
Why You Shouldn’t Be Scared of TypeScript
Five C# Features You Might Not Know
// فقط یک ترد امکان دسترسی به کد را داشته باشد
private static readonly SemaphoreSlim _semaphoreSlim = new SemaphoreSlim(1,1);
public async Task RunAsync()
{
// شروع تمام تردها معلق خواهند شد تا این سمافور به پایان برسد
// پس از پایان کار ترد جاری، فقط یک ترد در حال انتظار، مجوز دسترسی به قطعه کد بعدی را خواهد یافت و به همین ترتیب برای سایر تردها
await _semaphoreSlim.WaitAsync();
try
{
await Task.Delay(20000); // Your code here
}
finally
{
_semaphoreSlim.Release();
}
} // فقط یک ترد امکان دسترسی به کد را داشته باشد
private static readonly SemaphoreSlim _semaphoreSlim = new SemaphoreSlim(1,1);
public override async Task RunAsync()
{
// شروع تمام تردها معلق خواهند شد تا این سمافور به پایان برسد
// پس از پایان کار ترد جاری، فقط یک ترد در حال انتظار، مجوز دسترسی به قطعه کد بعدی را خواهد یافت و به همین ترتیب برای سایر تردها
await _semaphoreSlim.WaitAsync();
try
{
await Task.Delay(20000); // Your code here
}
finally
{
_semaphoreSlim.Release();
}
} <system.web>
<globalization uiCulture="fa-IR" culture="fa-IR" />
</system.web> protected void Application_BeginRequest()
{
Thread.CurrentThread.CurrentCulture = new CultureInfo("fa-IR");
Thread.CurrentThread.CurrentUICulture = new CultureInfo("fa-IR");
} public void Configure(IApplicationBuilder app)
{
app.UseRequestLocalization(new RequestLocalizationOptions
{
DefaultRequestCulture = new RequestCulture(new CultureInfo("fa-IR")),
SupportedCultures = new[]
{
new CultureInfo("en-US"),
new CultureInfo("fa-IR")
},
SupportedUICultures = new[]
{
new CultureInfo("en-US"),
new CultureInfo("fa-IR")
}
}); c='en-UK'|uic='en-US'
public IActionResult SetFaLanguage()
{
Response.Cookies.Append(
CookieRequestCultureProvider.DefaultCookieName,
CookieRequestCultureProvider.MakeCookieValue(new RequestCulture(new CultureInfo("fa-IR"))),
new CookieOptions { Expires = DateTimeOffset.UtcNow.AddYears(1) }
);
return RedirectToAction("GetTitle");
} 
public void ConfigureServices(IServiceCollection services)
{
services.AddLocalization(options => options.ResourcesPath = "Resources");
services.AddMvc()
.AddViewLocalization(LanguageViewLocationExpanderFormat.Suffix)
.AddDataAnnotationsLocalization(); 
using System;
using System.Globalization;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Localization;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Localization;
using Microsoft.Extensions.Localization;
namespace Core1RtmEmptyTest.Controllers
{
public class TestLocalController : Controller
{
private readonly IStringLocalizer<TestLocalController> _stringLocalizer;
private readonly IHtmlLocalizer<TestLocalController> _htmlLocalizer;
public TestLocalController(
IStringLocalizer<TestLocalController> stringLocalizer,
IHtmlLocalizer<TestLocalController> htmlLocalizer)
{
_stringLocalizer = stringLocalizer;
_htmlLocalizer = htmlLocalizer;
}
public IActionResult Index()
{
var name = "DNT";
var message = _htmlLocalizer["<b>Hello</b><i> {0}</i>", name];
ViewData["Message"] = message;
return View();
}
[HttpGet]
public string GetTitle()
{
var about = _stringLocalizer["About Title"];
return about;
}
public IActionResult SetFaLanguage()
{
Response.Cookies.Append(
CookieRequestCultureProvider.DefaultCookieName,
CookieRequestCultureProvider.MakeCookieValue(new RequestCulture(new CultureInfo("fa-IR"))),
new CookieOptions { Expires = DateTimeOffset.UtcNow.AddYears(1) }
);
return RedirectToAction("GetTitle");
}
}
} @using Microsoft.AspNetCore.Mvc.Localization
@inject IViewLocalizer Localizer
@{
}
Message @ViewData["Message"]
<br/>
@Localizer["<b>Hello</b><i> {0}</i>", "DNT"]
<br/>
@Localizer["About Title"] using System.ComponentModel.DataAnnotations;
namespace Core1RtmEmptyTest.ViewModels.Account
{
public class RegisterViewModel
{
[Required(ErrorMessage = "EmailReq")]
[EmailAddress(ErrorMessage = "EmailType")]
[Display(Name = "Email")]
public string Email { get; set; }
}
} 
// Dummy class to group shared resources
namespace Core1RtmEmptyTest
{
public class SharedResource
{
}
} IStringLocalizer<SharedResource> sharedLocalizer
@inject IHtmlLocalizer<SharedResource> SharedLocalizer