Лаконично, выразительно, делает одно: ваш код должен говорить на TED с использованием принципа TED.

«Лаконично, выразительно, выполняет одну задачу» чаще всего называют правилом TED или принципом TED. Таким образом, его основная концепция - это именование кода, которое должно быть понятно каждому (программистам). Итак, при написании кода. Мы должны учитывать, что наша аудитория - это не только компьютер, но и человек.

Как говорит Мартин Фаулер

Любой дурак может написать код, понятный компьютеру. Хорошие программисты пишут код, понятный людям.

Именование кода имеет значение, потому что четкие имена могут быстро сообщить читателю цель и упростить выполнение кода.

Вот рекомендации по именованию классов, методов и переменных с использованием правила TED.

1. Именование классов, они должны быть существительными и одно дело.

• В названии класса должно быть существительное. Таким образом, нельзя использовать глагольные, множественные и общие суффиксы. и Т. Д.

ГРЯЗНО:

public class Users {}
public class FoundUser {}

ЧИСТАЯ:

public class  User {}
public class Account { }

• Название класса должно быть конкретным. Так что избегайте общих имен, потому что иногда ленивые разработчики могут прийти и написать на них.

ГРЯЗНО:

public class Common {}

ЧИСТЫЙ:

public class Student {}

• У класса должна быть единственная ответственность. Например, ваш класс User не должен обрабатывать платежи.

ГРЯЗНО:

public class User {
public Guid Id { get; set ;};
public string Name { get; set ;};
public int Debit { get; set ;};
public int Credit { get; set ;};
public string PaymentType { get; set ;};
}

ЧИСТЫЙ:

public class User {
public Guid Id { get; set ;};
public string Name { get; set ;};
public Guid PaymentId { get; set ;};
}
public class Payment {
public Guid Id{ get; set ;};
public int Debit { get; set ;};
public int Credit { get; set ;};
public string PaymentType { get; set ;};
}

2. Методы наименования должны четко выражать их цель.

В названии метода используется глагол, и в нем должно быть указано его назначение.

ГРЯЗНО:

get ();
process();
start();
destroy();

ЧИСТО:

getRegisteredUsers();
isValidUser();
exportHistoryReportToExcel();
sendEmail();

3. ВНИМАНИЕ: будьте внимательны во имя «И», «Если», «Или».

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

ГРЯЗНО:

signupAndSendVerificationEmail();

ЧИСТО:

signup();
sendVerificationEmail();

4. Избегайте сокращений.

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

ГРЯЗНО:

regUsr();
regisUsr();
calP();

ЧИСТО:

registerUser();
calculateTotalPrice ();

5. Будьте предельно ясны при именовании переменных.

Переменная с точным и точным именем помогает снизить риск неправильного понимания цели кода.

ГРЯЗНО:

List<decimal> p = new ArrayList<>() {5  , 10 , 20 , 30 } ;

ЧИСТО:

List<decimal> prices = new ArrayList<>() {5  , 10 , 20 , 30 } ;

6. Именование логических значений должно походить на вопросы «правда / ложь».

Имена логических переменных должны вызывать у вас чувство, будто вы отвечаете на правильный или ложный вопрос.

ГРЯЗНО:

if (open) {
// do something
}

ЧИСТО:

if (isOpen) {
// do something
}

Как инженеры-программисты, мы несем ответственность за создание программного обеспечения наилучшего качества, которое лучше всех подходит для всех. Не нужно искать краткосрочной цели. Таким образом, самое важное, что следует учитывать, - это техническое обслуживание в будущем. Хороший инженер-программист всегда должен учитывать ремонтопригодность и удобочитаемость. Так что в будущем мы не будем тратить время на отладку и выяснение проблем.

Автор: Марк Кеннет Ломио | Разработчик программного обеспечения полного стека | BlastAsia, Inc.

ИСПОЛЬЗОВАННАЯ ЛИТЕРАТУРА:

Https://jorcus.com/ultimate-guide-of-writing-clean-code/