✴️ اصل Bad Comments در کلین کد:
آموزش های امروز برای بخشی از کامنت هاست که سود خاصی برامون ندارن و الکی کد رو شلوغ میکنن
این اصل چندتا زیر مجموعه داره و کامنت های بدی که میتونید بذارید رو به طور خلاصه بررسی میکنیم:
1️⃣ Mumbling یعنی اینکه کامنتی بذاری که نامفهمومه و بیشتر از اینکه بدرد بخور باشه باعث سر در گمی میشه
2️⃣
Redundant Comments یعنی کامنت هایی که بدرد نخور و اضافن و خوندنشون از خوندن کد، زمان بیشتری میبره
3️⃣ Misleading Comments یعنی یجور لقمه رو دور سر بپیچونی که کسی که کامنت رو میخونه کلا فکر و ذهنش منحرف بشه به یه سمت دیگه
4️⃣ Mandated Comments کامنت هایی که برای هر متغیری مینویسید و معمولا زیاد بدرد نمیخورن مثل javadocs
5️⃣
Journal Comments
این اصل، اینطوریه بیای و تغییرات پروژه رو هر بار تو کامنتها بزنی ، اینکار برای قبل از اومدن سیستم های کنترل ورژن مثل گیت بود این نوع کامنتا الان بدرد نمیخورن
6️⃣
Noise Comments کامنت هایی که کار خاصی ندارن و فقط کد رو شلوغ کردن مثل:
/** The day of the month. */
private int dayOfMonth;
7️⃣
Commented-Out Code کامنت کردن کد ها هم یکی از بدترین نوع کامنت هاست و باعث به هم ریختگی میشه
8️⃣
Too Much Information یعنی اینکه تو کامنت اطلاعات زیادی بدی انقدر زیاد باشه خوندنش کلی وقت ببره
#برنامه_نویسی #درسمن_پوینت #کلین_کد
🆔️
@darsmancom 🌐
www.darsman.com