www.dntips.ir
مطالب ۳۶۹۴
نویسندگان ۲۷۶
گروه‌های مطالب ۱۰۲۴
نقشه‌های راه ۱۱۹
دوره‌ها ۱۴
اشتراک‌ها ۱۷۹۱۴
عنوان:

‫آرگومان‌های نامگذاری شده (named arguments/parameters) در C#4


نویسنده: وحید نصیری
تاریخ: ۱۳۸۹/۰۳/۱۶ ۱۸:۵۸:۰۰
آدرس: www.dntips.ir
سؤال: آیا شما بدون مراجعه به مستندات شیء FormsAuthenticationTicket می‌توانید پاسخ دهید هر کدام از آرگومان‌های ذکر شده در سازنده‌ی این کلاس چه کاربرد و معنایی دارند؟
            var ticket = new FormsAuthenticationTicket
               (
                 1,
                 principal.Identity.Name,
                 DateTime.Now,
                 DateTime.Now.AddMinutes(30),
                 true,
                 string.Empty,
                 FormsAuthentication.FormsCookiePath
               );

الان چطور؟!
            //using named parameters of C# 4.0
           var ticket = new FormsAuthenticationTicket
               (
                 version: 1,
                 name: principal.Identity.Name,
                 issueDate: DateTime.Now,
                 expiration: DateTime.Now.AddMinutes(30),
                 isPersistent: true,
                 userData: string.Empty,
                 cookiePath: FormsAuthentication.FormsCookiePath
               );

گاهی از اوقات ویژگی‌هایی که به یک زبان برنامه نویسی اضافه می‌شوند راه و روش برنامه نویسی را ممکن است کاملا تحت تاثیر قرار دهند؛ برای مثال استفاده از Generics . اما گاهی از اوقات این ویژگی‌های جدید syntax sugar یا nice to have هستند(!) مانند Named arguments .
Named arguments یا آرگومان‌های نامگذاری شده خوانایی کدهای شما را با بیان اینکه هر آرگومان چه معنایی دارد، افزایش می‌دهند. برای مثال به نظر شما کدام روش فراخوانی متد Copy در ذیل خواناتر است؟
File.Copy("source.txt", "destination.txt", true);
و یا؟
File.Copy("source.txt", "destination.txt", overwrite: true);
هر دو یک کار را انجام می‌دهند اما درک عملکرد روش اول حتما نیاز به بررسی مستندات متد Copy را خواهد داشت.

نکات تکمیلی:
متد ساده زیر را در نظر بگیرید:
static void Foo(int x, int y) {}
الف) در حالت معمولی و بدون استفاده از named argument ، پارامترهای یک متد، positional parameters هم نامیده می‌شوند. به این معنا که محل ذکر یک پارامتر مهم است و برای مثال در روش متداول فراخوانی ذیل، پارامتر دوم همیشه همان y است و پارامتر اول همواره همان x درنظر گرفته می‌شود:
Foo(1,2);
اما زمانیکه از named parameters استفاده می‌کنید، این ترتیب دیگر اهمیتی نداشته و هر دو فراخوانی ذیل مجاز می‌باشند و به یک معنا هستند:
Foo(x:4, y:2);


Foo(y:2, x:4);
ب) همواره positional parameters باید پیش از named parameters ذکر شوند. برای مثال فراخوانی ذیل مجاز است:
Foo(4, y:2);
اما فراخوانی زیر مجاز نبوده و برنامه کامپایل نخواهد شد:
Foo(x:4, 2);     // Compile time error
مطالب مشابه

نظرات

  • وحید نصیری در ۱۳۹۶/۱۱/۳۰ ۹:۹
    یک نکته‌ی تکمیلی: بهبود جزئی آرگومان‌های نامدار در C# 7.2

    تا پیش از C# 7.2، آرگومان‌های نامدار، تنها پس از ذکر آرگومان‌های بدون نام، مجاز بودند. برای مثال اگر امضای متدی به صورت زیر باشد:
    public static void Write(int age, string name, string homeTown)
    فراخوانی آن به صورت زیر تا C# 7.2 مجاز نبود:
    Write(age: 20, "User 1", homeTown: "Tehran");
    و باخطای کامپایلر زیر، کامپایل نمی‌شد:
    Named argument specifications must appear after all fixed arguments have been specified.
    این محدودیت در C# 7.2 برطرف شده‌است؛ به این شرط که موقعیت پارامترها تغییری نکنند و پارامترها دقیقا در همانجایی که قرار است باشند، معرفی شوند.
    در این حالت تمام فراخوانی‌های ذیل در C# 7.2 مجاز هستند:
    Write(age: 20, name: "User 1", "T1");
Write(age: 21, "User 2", homeTown: "T2");
Write(age: 22, "User 3", "T3");
Write(23, name: "User 4", "T4");
  • وحید نصیری در ۱۴۰۳/۰۶/۱۸ ۱۵:۳۰

    یک نکته‌ی تکمیلی: روش نمایش خودکار آرگومان‌های نامدار در Rider

    اگر از Rider استفاده می‌کنید و علاقمندید تا خودش کار تکمیل و نمایش آرگومان‌های نامدار را انجام دهد، روش کار به صورت زیر است:

    الف) ویژگی فرمت کردن کدها را در حالت ذخیره سازی تغییرات، فعال کنید:

    با اینکار، هربار که تغییرات را ذخیره می‌کنید، تنظیمات کدنویسی، به صورت خودکار به فایل‌های ذخیره نشده‌، اعمال می‌شوند.

    ب) به قسمت Settings -> Editor -> Cody Style -> C# -> Syntax Style مراجعه کرده و در قسمت تنظیمات آرگومان‌ها، حداقل گزینه‌های Literal values و String literal values را بر روی named argumets قرار دهید تا نکات مطلب جاری، به صورت خودکار اعمال شوند:

    همانطور که در مثال before/after تصویر فوق هم مشخص است، مزیت اینکار، مفهوم پیدا کردن اعداد و رشته‌های وارد شده به عنوان آرگومان‌های متدها هستند.