Чистый код — Соглашение об именах

Введение

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

1. Выбирайте описательные и понятные имена

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

// Bad example:
const d = new Date();

// Good example:
const currentDate = new Date();

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

// Bad example:
const getAll = () => { ... };

// Good example:
const getAllUsers = () => { ... };

2. Соблюдайте соглашения об именах

2.1 Следуйте установленным соглашениям. Соблюдайте общепринятые соглашения об именах в сообществе JavaScript. Например, используйте верблюжий регистр для переменных и функций и PascalCase для классов и конструкторов.

// Bad example:
const first_name = 'John

// Good example:
const firstName = 'John';

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

javascriptCopy code// Bad example:
const get = () => { ... };
const fetchRecords = () => { ... };
const retrieveData = () => { ... };

// Good example:
const get = () => { ... };
const getRecords = () => { ... };
const getData = () => { ... };

3. Обеспечьте адекватный контекст

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

// Bad example:
const get = () => { ... };

// Good example:
const getUser = () => { ... };

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

// Bad example:
const products = [];

// Good example:
const availableProducts = [];

4. Рефакторинг, если имена слишком длинные

4.1. Предпочтите удобочитаемость краткости. Несмотря на то, что предпочтительны краткие имена, важно отдавать предпочтение удобочитаемости. Если более длинное имя более точно описывает объект, выберите его вместо более короткого, но менее значимого варианта.

// Bad example:
const getUsrs = () => { ... };

// Good example:
const getUsers = () => { ... };

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

// Bad example:
const custCnt = 5;

// Good example:
const customerCount = 5;

Заключение

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