✅️ اصل Good Comments در کلین کد:
این اصل چندتا زیر مجموعه داره و کامنت های مفیدی که میتونید بذارید رو گفته تو این پست سعی میکنم به طور خلاصه همشون رو بگم
1️⃣ Legal Comments
گاها نیازه که تو اول هر فایل سورس یه سری کامنت درباره ارزش های حقوقی پروژه بذارید مثل این کامنت توی FitNesse
// Copyright (C) 2003,2004,2005 by Object Mentor, Inc. All rights reserved.
// Released under the terms of the GNU General Public License version 2 or later.
2️⃣ Informative Comments
خوبه که بعضی مواقع یه سریع توضیحات دقیق و مختصر رو کامنت کنیم. البته بهتره تا جایی که میشه اسم تابع این اطلاعات رو بهمون بده ولی اگه نشد یه کامنت بزارید مثلا :
// Returns an instance of the Responder being tested.
protected abstract Responder responderInstance()
3️⃣ Explanation of Intent
بعضی مواقع خوبه که هدفی که از نوشتن اون تیکه کد رو داشتید کامنت کنید (با این که در اکثر مواقع نیازی به کامنت نیست)
4️⃣ Clarification
گاها خوبه که اون تیکه از کدمون که یه مقدار مبهمه به صورت ساده شده یه کامنت در بارش بزاریم مثلا:
assertTrue(a.compareTo(a) == 0); // a == a
assertTrue(a.compareTo(b) != 0); // a != b
5️⃣ Warning of Consequences
ممکنه یه تیکه کدی داشته باشید که ران کردنش یه عواقبی داشته باشه حالا چه کم چه زیاد؛ بهتره براش تو کامنت‌ها هشدار بنویسید که برنامه نویس های دیگه حواسشون باشه
6️⃣ TODO Comments
بعضی وقتا قصد دارید که بعدا یک قسمتی رو بهبود بدید یا اضافه کنید اینطور مواقع میتونید TODO بزارید که با TODO // شروع میشه معمولا.
#درسمن_پوینت #کلین_کد #برنامه_نویس
🆔️ @darsmancom
🌐 www.darsman.com