Вы можете быть любителем или профессионалом в программировании, но независимо от вашей квалификации каждый из нас встречает имена в нашей программе повсюду. Будь то переменная, функция, класс, пакет, аргумент, каждое из них - это имена, которые мы должны определить сами. Потому что мы с ними больше занимаемся, лучше делать это хорошо. Эта статья поможет в этом процессе.
Давайте разберем это на несколько подтем следующим образом:
- Используйте имена, раскрывающие намерение
- Избегайте дезинформации
- Используйте произносимые имена
- Используйте имена с возможностью поиска
Используйте имена, раскрывающие намерение
Несмотря на то, что мы думаем, что это не то, чему мы должны уделять больше внимания в программе, это экономит больше, чем нужно. Любой, кто читает код, поймет, какова цель этого слова, и это сделает их, так же как и вас, приятным чтением кода. 😃
int a; // number of units
Здесь мы видим, что определенная переменная «a» описана комментарием. Потому что имя «а» ничего не значит. Если имя требует комментария, то имя не раскрывает его намерения.
Вместо этого мы можем использовать имя, как показано ниже:
int numberOfUnits; int unitCount;
Мы видим, что каждое имя само по себе вызывает его намерение. Так понятнее и приятнее всем читать. Кроме того, это позволяет нам намного проще вносить изменения в будущем.
Избегайте дезинформации
Как программистам, лучше избегать инициализации ключей ложных имен, которые могут сделать неясным значение кода. Например; hp, aix и sco - плохие имена переменных, потому что они являются именами платформ или вариантов Unix.
Кроме того, нам следует избегать использования имен как, объединяя слово «List» с именами, если только оно не является списком. Поскольку слово «Список» является специфическим словом для программистов, оно может ввести читателя в заблуждение.
В качестве примера:
String nameList; String productList;
Мы можем заменить указанные выше имена переменных как:
String nameGroup; // or String groupOfNames; String setOfProducts;
Затем дело доходит до информации и дезинформации. Подобное написание аналогичных понятий - это информация. Использование непоследовательного написания - дезинформация. Очень полезно, если имена для очень похожих вещей сортируются вместе в алфавитном порядке и если различия очень очевидны, потому что разработчик, скорее всего, без колебаний выберет объект по имени.
Распространенной ошибкой дезинформации является использование строчной буквы "L" или прописной буквы "O" для имен переменных. Которые, скорее всего, перепутают с цифрой 1 (единица) и цифрой 0 (ноль) соответственно.
int a = l; if ( O == l ) a = O1; else l = 01;`
Здесь мы можем увидеть пример использования вышеупомянутого использования дезинформации. Проблема в том, что они выглядят почти одинаково, и это может сбить с толку как читателя, так и программиста. Поэтому мы должны исключить использование дезинформации вместо информации.
Используйте произносимые и доступные для поиска имена
Вам может быть интересно, почему имена должны быть произносимыми, если они просто скрыты за кодом и никогда не кажутся написанными. Но на самом деле их читают и редактируют разные разработчики или, может быть, новые разработчики. Если вы не можете произнести его, вы не сможете обсудить это с остальными людьми, и вам не удастся передать точную идею или намерение соответствующего имени.
class DtaRcrd102 {
private Date genymdhms;
private Date modymdhms;
private final String pszqint = "102";
* ... */
};
Мы можем изменить приведенный выше пример кода следующим образом:
class Customer {
private Date generationTimestamp;
private Date modificationTimestamp;;
private final String recordId = "102";
/* ... */
};
Значение использования доступных для поиска имен; объявляемые нами имена не должны быть однобуквенными или числовыми константами, поскольку их невозможно найти в огромном теле текста. В качестве примера:
int e;
Буква «e» - обычная буква в английском языке, и она часто встречается во всем коде. Итак, если бы нам пришлось найти эту константу, она по желанию даст так много результатов, как и в каждом отрывке. Мы не хотим, чтобы такой разброс. Поэтому лучше не использовать такие отдельные буквы или числовую константу, за исключением того, что это локальная переменная внутри короткого метода.
for (int j=0; j < NUMBER_OF_UNITS; j++)
Это некоторые важные факторы, на которых мы должны сосредоточиться при кодировании программы, и следование им по привычке может сделать ваш код более структурным и читаемым для вас, а также для читателей. Выполните эти простые шаги и посмотрите, не улучшите ли вы читаемость кода. 😎
Спасибо, что прочитали !
Давайте познакомимся с другими правилами кодирования во второй части этой темы.
Ссылки
Мартин, Роберт Сесил. Чистый код: руководство по созданию гибкого программного обеспечения. Прентис Холл, 2009.
Гузель, Бурак. 15+ лучших практик для написания суперчитаемого кода. Code Envato Tuts +, Envato Tuts, 30 марта 2011 г., https://code.tutsplus.com/tutorials/top-15-best-practices-for-writing-super-readable-code - net-8118.
