Skip to content

Commit

Permalink
edit 4.19-commentary.md -> content -> done
Browse files Browse the repository at this point in the history
  • Loading branch information
ar-mokhtari committed May 17, 2023
1 parent b35696a commit d005a1b
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions content/chapter 4/4.19-commentary.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ weight: 7019
«کامنت» به توضیحات‌ی گفته می‌شود که داخل کد، به‌قصد «یادآوری»، «جلب‌توجه مخاطب به موضوع‌(ها)ی خاص»، کمک به onboard شدن اعضاء جدید تیم و مانند اون نگارش می‌شود. در زبان گو، به شیوه‌های زیر کامنت می‌گذاریم:
- قرار دادن `//` در ابتدای سطر.
```go
// defined to store multi string
// defined to store multi string (see below why this is not a good comment)
var sliceVar []string
````

Expand Down Expand Up @@ -95,6 +95,15 @@ func delete(m map[Type]Type1, key Type)
5. وجودش آگاه‌کننده موضوع بااهمیت بالاست.
6. مربوط به موضوعی است که اکنون وجود دارد (بروزرسانی کامنت‌ها-حذف کامنت‌های اضافی)
7. ادبیات کامنت، بسته به تیم و دستورالعمل‌ها، بهتر است رسمی نگارش شود تا عمومی بماند. البته گاهی کمی شوخ‌طبعی هم اگر کنترل‌شده باشد، باعث انتقال‌مطلب بهتر می‌شود.
8. درصورت لازم بودن یک یا چند منبع مرتبط با کد، حاوی لینک url خواهد بود.
```go
// flip the buffer for this connection if we need to drain it.
// note that for a successful query (i.e. one where rows.next()
// has been called until it returns false), `rows.mc` will be nil
// by the time the user calls `(*Rows).Close`, so we won't reach this
// see: https://github.com/golang/go/commit/651ddbdb5056ded455f47f9c494c67b389622a47
mc.buf.flip()
```

# به پرتگاه نزدیک می‌شوید!
- زامبی کد: به کدی می‌گویند که به دلیل عدم کارایی، اصلاح با کد جدید، و یا مشابه این موارد، بجای «حذف»، «کامنت» می‌شوند.
Expand All @@ -105,4 +114,3 @@ func delete(m map[Type]Type1, key Type)
- کامنت‌های شما، نباید تبدیل به «نویز» درکدنویسی دیگران شود. تعدد کامنت‌ها کد را تبدیل به کد کثیف می‌کند که خوانایی ضعیفی خواهد داشت.
- کامنت، جای دردل کردن، شکایت از مدیرپروژه، تعریف از خود و گفتگو نیست.

`این متن اصلاح و تکمیل خواهد شد`

0 comments on commit d005a1b

Please sign in to comment.