همیشه بهمون گفتن: «کد خوب Comment نداره.»
اما واقعیت اینه:
کد خوب Comment غیرضروری نداره، نه اینکه هیچ Commentی نداشته باشه.
کامنت های خوب کامنت هایی هستند که چرایی (Why) رو توضیح میدهند، نه چیستی (What) رو.
و یه نکته مهم: Comment ≠ Documentation ≠ ADR
چرا این خط کد اینطوری نوشته شده؟ Comment
سیستم چطور کار میکنه؟Documentation
چرا این تصمیم معماری رو گرفتیم؟ ADR
پس هدف این نیست که Comment نداشته باشیم؛ هدف اینه که بدونیم چه چیزی باید در کد، چه چیزی در Documentation و چه چیزی در ADR ثبت بشه.
و Clean Code به معنیه حذف Comment نیست؛ حذف Commentهای بیارزشه.
@DevTwitter | <Amir Mohammd M./>
Post #13110
6.74K

- 👍 48
- ❤ 15
- 🍌 9