JAVA_IIBRARY Telegram 1858
Почему важно давать хорошие имена в коде?

Потому что большую часть времени мы не пишем код, а читаем его. И одно удачное имя способно объяснить то, что комментарий бы растянул на три строки.

Что решает хорошее имя:

Намерение: expireSession() говорит больше, чем process().
Контекст: calculatePriceWithTax() понятнее, чем просто calculate().
Контракт: isEmpty() (логический результат) и getSize() (число) — разное поведение, и имя это чётко показывает.

Простые, но работающие правила:

Глагол + объект для действий: sendInvoiceEmail().
Ясное существительное для данных: PaymentRequest, CustomerId.
Без тайнописи вроде cfg, mgr, tmp2.
Если логика нетривиальна, пусть имя объясняет “почему”: retryOnRateLimit().

А комментарии не нужны? 🤔

Нужны, но точечно. Пиши их там, где код сам не может выразить мысль:

когда решение неочевидное;
когда нужна историческая справка или ссылка на ADR.

Главное не использовать комментарии, чтобы объяснять то, что код и так должен рассказывать сам.

👉 Java Portal
Please open Telegram to view this post
VIEW IN TELEGRAM
👍132



tgoop.com/Java_Iibrary/1858
Create:
Last Update:

Почему важно давать хорошие имена в коде?

Потому что большую часть времени мы не пишем код, а читаем его. И одно удачное имя способно объяснить то, что комментарий бы растянул на три строки.

Что решает хорошее имя:

Намерение: expireSession() говорит больше, чем process().
Контекст: calculatePriceWithTax() понятнее, чем просто calculate().
Контракт: isEmpty() (логический результат) и getSize() (число) — разное поведение, и имя это чётко показывает.

Простые, но работающие правила:

Глагол + объект для действий: sendInvoiceEmail().
Ясное существительное для данных: PaymentRequest, CustomerId.
Без тайнописи вроде cfg, mgr, tmp2.
Если логика нетривиальна, пусть имя объясняет “почему”: retryOnRateLimit().

А комментарии не нужны? 🤔

Нужны, но точечно. Пиши их там, где код сам не может выразить мысль:

когда решение неочевидное;
когда нужна историческая справка или ссылка на ADR.

Главное не использовать комментарии, чтобы объяснять то, что код и так должен рассказывать сам.

👉 Java Portal

BY Java Portal | Программирование




Share with your friend now:
tgoop.com/Java_Iibrary/1858

View MORE
Open in Telegram


Telegram News

Date: |

Some Telegram Channels content management tips The Channel name and bio must be no more than 255 characters long A Hong Kong protester with a petrol bomb. File photo: Dylan Hollingsworth/HKFP. The group also hosted discussions on committing arson, Judge Hui said, including setting roadblocks on fire, hurling petrol bombs at police stations and teaching people to make such weapons. The conversation linked to arson went on for two to three months, Hui said. The best encrypted messaging apps
from us


Telegram Java Portal | Программирование
FROM American