یک نام برای این متغیر انتخاب کد که با اصول کد تمیز منطبق باشد: متغیری که رشتهای از…
- User
یک نام برای این متغیر انتخاب کد که با اصول کد تمیز منطبق باشد: متغیری که رشتهای از کاربر میگیرد و در مسیر فعلی، یک پوشۀ جدید به آن نام ایجاد میکند و فایل جاری را در آن مسیر saveAs میکند. این متغیر را در زبان سی شارپ بنویس و آن را کامل مستند کن
Assistant
یک سوال عالی در مورد Clean Code!
اول بیایید اصول نامگذاری در کد تمیز (Clean Code) رو مرور کنیم:
- نام باید گویا و معنادار باشد (Meaningful Names): نام متغیر باید دقیقا بیانگر وظیفه و محتوای آن باشد.
- از نامهای کوتاه و رسا استفاده شود (Short but Descriptive): مثلاً
xخوب نیست ولیfolderNameعالی است! - قاعده نامگذاری مشخص باشد (Consistent Naming Convention): در سیشارپ معمولا از PascalCase برای نام خواص و متدها و camelCase برای متغیرهای محلی استفاده میکنیم.
- نام نباید حاوی اطلاعات اضافه باشد (Avoid Disinformation): مثلاً اگر متغیری فقط نام فولدر میگیرد، نیاید بنویسیم
newFolderPathThatWeCreateRightNowچون اطلاعات اضافه داره! - نام باید بیانگر هدف (Intent) باشد نه نحوه پیادهسازی (Implementation).
حالا بریم سراغ این متغیر خاص:
متغیری که رشتهای از کاربر میگیرد و در مسیر فعلی، یک پوشه جدید به آن نام ایجاد میکند و فایل جاری را در آن مسیر
saveAsمیکند.گزینههای پیشنهادی برای نام این متغیر:
targetFolderName→ چون دقیقا میگوید این متغیر نام پوشه هدف (که قراره ساخته بشه) است.newDirectoryName→ اینجاDirectoryتاکید کرده که با سیستم فایل سروکار داریم.userSpecifiedFolderName→ چون ورودی از کاربر گرفته شده و کاملا گویاست.
اما بهترین گزینه (به نظرم) این است:
destinationFolderNameچرا؟
- Destination یعنی «مقصد» که میفهمانیم فایل جاری دارد به آنجا منتقل میشود.
- FolderName تاکید دارد که فقط «نام» پوشه است نه کل مسیر (Path).
حالا بیایید کد کامل سیشارپش رو با مستندات بنویسیم:
using System; using System.IO; /// <summary> /// کلاسی برای مدیریت ذخیرهسازی فایلها در پوشههای جدید. /// </summary> public class FileSaver { /// <summary> /// نام پوشه مقصد که توسط کاربر مشخص میشود و فایل جاری در آن ذخیره خواهد شد. /// </summary> private readonly string destinationFolderName; /// <summary> /// سازنده کلاس که نام پوشه مقصد را از کاربر دریافت میکند. /// </summary> /// <param name="destinationFolderName">نام پوشهای که کاربر میخواهد ایجاد شود و فایل در آن ذخیره گردد.</param> public FileSaver(string destinationFolderName) { // اینجا چک میکنیم ببینیم رشته خالی نداده باشه کاربر! if (string.IsNullOrWhiteSpace(destinationFolderName)) { throw new ArgumentException("نام پوشه مقصد نمیتواند خالی باشد.", nameof(destinationFolderName)); } this.destinationFolderName = destinationFolderName.Trim(); // حذف فاصلههای اضافی اول و آخر } /// <summary> /// فایل جاری برنامه را در مسیر جدید ذخیره میکند. /// </summary> /// <param name="currentFilePath">مسیر فعلی فایل که باید ذخیره شود.</param> /// <exception cref="FileNotFoundException">اگر فایل جاری وجود نداشته باشد.</exception> /// <exception cref="IOException">اگر پوشه یا فایل با خطای سیستمی ایجاد/ذخیره نشود.</exception> public void SaveFileAsInNewFolder(string currentFilePath) { // ۱. چک کنیم فایل مبدا وجود داشته باشه if (!File.Exists(currentFilePath)) { throw new FileNotFoundException("فایل جاری پیدا نشد.", currentFilePath); } // ۲. مسیر کامل پوشه مقصد را بسازیم (همان مسیر فعلی برنامه + نام پوشه جدید) string currentDirectory = Directory.GetCurrentDirectory(); string newFolderPath = Path.Combine(currentDirectory, destinationFolderName); try { // ۳. اگر پوشه وجود نداشت، ایجادش کن if (!Directory.Exists(newFolderPath)) { Directory.CreateDirectory(newFolderPath); Console.WriteLine($"پوشه جدید با نام {destinationFolderName} در مسیر {currentDirectory} ایجاد شد."); } // ۴. نام فایل مقصد را استخراج کن (اسم فایل مبدا را نگه میداریم) string fileName = Path.GetFileName(currentFilePath); string destinationFilePath = Path.Combine(newFolderPath, fileName); // ۵. اگر فایلی با همین نام آنجا هست، یک هشدار بدهیم (اختیاری) if (File.Exists(destinationFilePath)) { Console.WriteLine($"هشدار: فایلی با نام {fileName} از قبل در پوشه مقصد وجود دارد. روی آن بازنویسی خواهد شد."); } // ۶. اکنون فایل را کپی/ذخیره کن (SaveAs) File.Copy(currentFilePath, destinationFilePath, true); // true یعنی overwrite مجاز است Console.WriteLine($"فایل با موفقیت در مسیر {destinationFilePath} ذخیره شد."); } catch (IOException ex) { throw new IOException($"خطا در ایجاد پوشه یا ذخیره فایل: {ex.Message}", ex); } catch (Exception ex) { throw new Exception($"خطای غیرمنتظره: {ex.Message}", ex); } } }نمونه استفاده:
class Program { static void Main() { Console.Write("لطفا نام پوشه جدید را وارد کنید: "); string folderName = Console.ReadLine(); // مثلا کاربر میزند: MyArchive var fileSaver = new FileSaver(folderName); string currentFile = @"C:\Users\User\Documents\report.txt"; // فرض کنیم این فایل جاری ماست try { fileSaver.SaveFileAsInNewFolder(currentFile); } catch (Exception ex) { Console.ForegroundColor = ConsoleColor.Red; Console.WriteLine("خطا: " + ex.Message); Console.ResetColor(); } Console.ReadKey(); } }توضیحات کد:
- در سازنده (
FileSaver) چک کردیم نام پوشه خالی نباشد. - متد
SaveFileAsInNewFolder:- چک میکند فایل مبدا (
currentFilePath) وجود داشته باشد. - مسیر جدید (
newFolderPath) را باPath.Combineمیسازد (که مشکل اسلش\یا/پیش نیاید). - اگر پوشه نبود با
Directory.CreateDirectoryمیسازد. - فایل را با
File.Copyمنتقل میکند.
- چک میکند فایل مبدا (
حالا چرا
destinationFolderNameبهترین انتخاب بود؟- چون نه زیاد کوتاه است (مثل
dir) نه زیاد طولانی (مثلtheFolderThatUserEnteredToSaveTheFileInIt). - دقیقا میفهمیم این متغیر «نام پوشه مقصد» است نه کل مسیر، نه نام فایل و نه چیز اضافهتر.
پس رعایت کردیم:
- معنا داشت (نام پوشهای که کاربر مشخص کرده)
- مختصر بود (نه خیلی کوتاه نه خیلی بلند)
- سازگار با قواعد سیشارپ بود (camelCase برای متغیر محلی)
- مستندات کامل هم به روش XML Comments اضافه کردیم که اگر کسی از Rider یا Visual Studio استفاده کرد، با ماوس هاور کرد روی متغیر/متد، متوجه کارکردش بشه.
موفق باشید در کدنویسی تمیز!
Other models, same or similar prompt
Responses were produced in different, uncontrolled contexts (system prompts, settings, prior turns). This is not a benchmark.