If it's stupid but works, it isn't stupid.
Философия 5S состоит из следующих концепций:

  • Сэйри, или организация. Абсолютно необходимо знать, где что находится —
    и в этом помогают такие методы, как грамотный выбор имен. Думаете, выбор
    имен идентификаторов неважен? Почитайте следующие главы.

  • Сэйтон, или аккуратность. Старая американская поговорка гласит: всему
    свое место, и все оказывается на своих местах. Фрагмент кода должен
    находиться там, где читатель кода ожидает его найти, — а если он находится
    где-то в другом месте, переработайте свой код и разместите его там, где ему
    положено быть.

  • Сэйсо, или чистка. Рабочее место должно быть свободно от висящих проводов,
    грязи, мусора и хлама. Что в этой книге говорят авторы о загромождении кода
    комментариями и закомментированными строками кода? Они советуют от
    них избавиться.

  • Сэйкэцу, или стандартизация: группа достигает согласия по поводу того, как
    поддерживать чистоту на рабочем месте. Что в этой книге сказано о наличии
    единого стиля кодирования и набора правил в группах? Откуда берутся эти
    стандарты? Прочитайте — узнаете.

  • Сюцукэ, или дисциплина. Программист должен быть достаточно
    дисциплинированным, чтобы следовать правилам, он должен часто размышлять о своей
    работе и быть готовым к изменениям.



Имена
Имена классов
Имена классов и объектов должны представлять собой существительные и их комбинации:
Customer, WikiPage, Account и AddressParser.
Имена методов
Имена методов представляют собой глаголы или глагольные словосочетания:
postPayment, deletePage, save и т. д. Методы чтения/записи и предикаты
образуются из значения и префикса get, set и i s согласно стандарту javabean.

Функции
Функции д.б. короткими.
Желательно, чтобы длина функции не превышала 20 строк.

Функция должна выполнять только одну операцию. она
должна выполнять ее хорошо, и ничего другого она
делать не должна.
стр.64

@темы: Р. Мартин - Чистый код. Создание, анализ и рефакторинг