آموزش کامنت گذاری در کدها به زبان ساده

هنگام نوشتن کدها؛ به سرعت به این واقعیت عادت خواهید کرد که تقریباً هر کاراکتر یا کلمه ای که وارد می کنید، معنای خاصی خواهد داشت. به عنوان مثال ، کلمات کلیدی زیادی را در سی شارپ مشاهده خواهید کرد، مانند کلاس، فضای نام، عمومی و موارد دیگر. همچنین خواهید دید که کامپایلر به شما اطمینان می دهد که از این کلمات کلیدی و همچنین متغیرها و متدهای خاص خود؛ به روشی صحیح استفاده خواهید کرد. سی شارپ یک زبان نسبتاً دقیق است و کامپایلر به شما کمک می کند تا اطمینان حاصل کنید که همه چیز به روشی که باید وارد شود؛ انجام شده است. با این حال ، شما به لطف کامت گذاری در کدها، یک فرصت واحد برای نوشتن هر آنچه دوست دارید خواهید داشت.

ممکن است قبلاً در برخی از کدهایی که در سی شارپ یا هر زبان برنامه نویسی دیگری دیده اید، کامنت گذاری در کدها را تجربه کرده باشید – مفهوم کامنت گذاری در کدها، بسیار جهانی است. نحوه نوشته شدن آنها اما بسیار متفاوت است، بنابراین اجازه دهید نگاهی به نوع کامنت گذاری هایی که می توانید در کد نویسی سی شارپ خود داشته باشید، بیندازیم.

کامنت های تک-خطی

اساسی ترین نوع کامنت در سی شارپ، کامنت های تک خطی است. همان طور که از نام آنها مشخص است؛ یک خط واحد را به یک کامنت تبدیل می کند- بیایید ببینیم این کامنت چگونه به نظر می رسد:

// My comments about the class name could go here…
class Program
{
……

بنابراین؛ همان طور که مشاهده می کنید؛ به شکل بالا نوشته می شود: خط های خود را با دو اسلش رو به جلو (//) آغاز کرده و متن شما از چیزی شروع می شود که کامپایلر بررسی کرده و موضوعی را درباره آن مطرح می کند و به چیزی می رسد که کامپایلر کاملاً نادیده گرفته است. و در حالی که این فقط به خط پیشوند اعمال می شود، شما آزادانه می توانید در خط بعدی نیز همین کار را انجام دهید، در اصل می توانید با استفاده از کامنت های تک خطی؛ کامنت های چند خطی ایجاد کنید:

// My comments about the class name could go here…
// Add as many lines as you would like
// …Seriously!
class Program
{
……

کامنت های چند خطی

در موردی که می خواهید چندین خط کامنت بنویسید؛ ممکن است منطقی تر باشد که از انواع مختلف کامنت های چند خطی استفاده کنید که سی شارپ پیشنهاد می دهد. به جای آن که در هر خط پیشوند به کار ببرید؛ فقط برای آغاز و پایان جملات خود از علامت اسلش ستاره استفاده می کنید و هر آنچه بین اینها قرار بگیرد؛ به عنوان کامنت در نظر گرفته می شود:

/*
My comments about the class name could go here…
Add as many lines of comments as you want
…and use indentation, if you want to!
*/
class Program
{
……

همان طور که در بالا مشاهده می کنید با یک اسلش رو به جلو-ستاره (/*) آغاز می کنید و سپس هر چه می خواهید می نویسید (که ممکن است چندین خط بشود) و سپس انتهای جمله را با ستاره-اسلش رو به جلو می بندید (*/). در بین این دو علامت می توانید هرچه بخواهید بنویسید.

مانند بسیاری از موضوعات دیگر مرتبط با برنامه نویسی؛ استفاده از چند کامنت تک خطی یا یک کامنت چند خطی معمولاً مورد بحث و شک است. به شخصه؛ برای موقعیت های متفاوت؛ من از هر دو استفاده می کنم؛ در نهایت انتخاب به خودتان بستگی دارد.

کامنت های مستند سازی

کامنت های مستندسازی (گاهی اوقات از آن به عنوان کامنت های مستندسازی XML یاد می شود) مشابه کامنت های منظم به نظر می آیند، اما XML در آنها جایگذاری شده است. درست مانند کامنت های منظم؛ آنها به دو شکل بیان می شوند: تک خطی و چند خطی. شما می توانید آنها را به همین ترتیب؛ اما یک کاراکتر اضافی بنویسید. بنابراین؛ کامنت های مستندسازی XML تک خطی به جای دو اسلش؛ ازسه تا اسلش رو به جلو (///) استفاده می کند و برای نوشتن کامنت های چند خطی باید یک ستاره به ابتدای شروع هر خط اضافه کنید. در مثال زیر می توانید بهتر مشاهده کنید:

class User
{
/// <summary>
/// The Name of the User.
/// </summary>
public string Name { get; set; }

/**
* <summary>The Age of the User.</summary>
*/
public string Age { get; set; }
}

در این بخش می توانید هر دو مدل تک خطی و چند خطی را مشاهده نمایید. نتیجه نیز یکسان خواهد بود؛ اما برای کامنت های مستند سازی مدل اولی که مشاهده می کنید؛ متداول تر است و بیشتر به کار می رود.

مستندسازی کدهای شما و آن چه در کامنت گذاری مستندسازی به کار می برید؛ موضوع بسیار مهمی است و از این رو؛ در مقاله های بعدی، بیشتر و عمیق تر به آن می پردازیم. اما اکنون می خواهیم ببینیم کدنویسی با کامنت گذاری به چه شکلی می باشد.

کامنت های کدها و لیست وظیفه

اگر از ویژوال استودیو استفاده می کنید؛ در واقع می توانید با ردیابی کامنت های کدهای تان؛ عملکرد بهتری داشته باشید. در پنجره Task List (می توانید از منوی View > Task List به آن پنجره دسترسی یابید)؛ کامنت های شما، اگر از سینتکس ویژه، اما بسیار ساده Task List استفاده می کنند؛ ظاهر خواهند شد:

//TODO: Change “world” to “universe”
Console.WriteLine(“Hello, world!”);
//HACK: Don’t try this at home….
int answerToLife = 42;

بنابراین اگر بعد از کامنت تک خطی بلافاصله TODO یا HACK قرار بگیرد، کامنت در Task List ویژوال استودیو به صورت زیر ظاهر می شود:

و بسته به نسخه ویژوال استودیویی که شما استفاده می کنید؛ انواع بیشتری می تواند وجود داشته باشد. در واقع نسخه ای که استفاده می کنید می تواند به برخی یا تمام کامنت های گذاشته شده زیر پاسخ بدهد:

• TODO
• HACK
• NOTE
• UNDONE

شما حتی می توانید علائم خودتان را نیز اضافه کنید – فقط کافی است مراحلی که در این بخش آمده؛ دنبال کنید.

خلاصه

کامنت گذاری کد در مستندسازی کد شما یا به منظور جاگذاشتن سرنخ هایی برای خودتان یا همکاران تان در مورد نحوه ی برنامه نویسی شما؛ می تواند بسیار مفید است. به عنوان یک مزیت اضافی ، وقتی شما نیاز دارید که چیزی را سریعاً آزمایش کنید، عالی هستند – فقط کافیست یک خط را کپی کرده و خط اصلی را کامنت کنید؛ سپس مشاهده خواهید کرد که کامنت گذاری چگونه کار می کند. اگر از نتیجه کار راضی نیستید، می توانید خط جدید را حذف کرده و خط اصلی را کامنت نکنید تا به جایی که شروع کرده اید بازگردید.

و نگران کاربر نهایی که ممکن است به کند و کاو کامنت های تان بپردازند؛ نباشید – این کامنت ها، همانطور که قبلاً نیز ذکر شد، توسط کامپایلر کاملاً نادیده گرفته می شوند و بنابراین به هیچ وجه در فایل DLL یا EXE نهایی شما گنجانده نشده اند. کامنت های کدها، در واقع فضای آزاد شخصی شما هنگام برنامه نویسی است ، بنابراین به هر روشی که می خواهید می توانید از این فضا استفاده کنید.