Для программиста качество кода является неотъемлемой частью процесса разработки, который делает его продуктивным и продуктивным. Я думаю, что было бы неплохо поделиться своим опытом разработки лучшего кода.
Это не руководство `ОБЯЗАТЕЛЬНО СЛЕДУЙТЕ`, вы также можете изменить свою версию или разработать собственную, чтобы она соответствовала вашим потребностям.
1. Составьте список словарного запаса:
Мы используем разные существительные, чтобы говорить об одних и тех же вещах. Например, чтобы сказать: «Символ акции», мы также используем «Символ тикера» или «Код инструмента», «Код акции» и т. д. С разной культурой и опытом люди могут использовать разные слова для описания одной и той же вещи. , чтобы избежать недоразумений, держите небольшой список для справки и оставайтесь постоянными.
let tickerSymbol; let stockSymbol; let insturmentSymbol; let stockCode;
⬇️
let tickerSymbol; // tickerSymbol refer as: stockSymbol, insturmentSymbol, stockCode
2. Назовите свою функцию с помощью префикса глагола:
Название функции распространено, люди используют свое воображение, чтобы назвать ее: `getUserList`, `userList`, `userListFromDatabase`, `usersListFromCache`.
Общепринятое правило английской грамматики: «Подлежащее + Глагол + Дополнение» сработало, если каждый класс или объект является подлежащим, то ДОЛЖЕН следовать глагол, поэтому просто назвать функцию глаголом — это естественно.
function getUserList() { } function userList() { } function userListFromDatabase() { } function userListFromCache() { }
⬇️
function getUserListFromDatabase() { } function getUserListFromCache() { }
3. Используйте префикс для параметров и возвращаемых значений:
Когда функция содержит много переменных, вам может быть трудно ее читать и понимать. Использование префикса может позволить вам прочитать наиболее важные переменные внутри функции. Лично мне больше всего нравится использовать `a` для аргументов и `r` для возвращаемых значений, некоторые люди могут использовать `i` для ввода и `o` для вывода. Оба способа работают нормально и работают отлично.
function doMyMagic(magicElement1, magicElement2) { return magicElement1 + magicElement2; }
⬇️
function doMyMagic(aMagicElement1, aMagicElement2) { let rMagicResult = aMagicElement1 + aMagicElement2 return rMagicResult; }
4. Все числа должны присваиваться переменным:
Одна из самых больших головных болей в исходном коде — это незакомментированные числа. Вместо того, чтобы использовать комментарий для комментирования чисел, почему бы просто не присвоить его переменной? Просто более легкий для чтения и осмысленный.
function getMinimiumSupportVersion() { return 7.0; }
⬇️
const kMinSupportVersion = 7.0; function getMinimiumSupportVersion() { let rMinSupportVersion = kMinSupportVersion; return rMinSupportVersion; }
5. Разработайте список сокращений:
Чтобы печатать меньше, мы обычно используем сокращения для длинных слов. Но не у всех людей есть общее понимание практики сокращения, например, некоторые люди используют «реклама» для обозначения «рекламы»; некоторые могут использовать `adv`. Просто ведите список, чтобы все говорили на одном языке.
6. Именование переменной сверху вниз:
Допустим, вы создаете регистрационную форму, у вас много меток. Общее название может выглядеть так:
let firstNameLabel; let lastNameLabel; let ageLabel; let addressLine1Label; let addressLine2Label; let addressLine3Label;
но в реальной жизни, когда вы взаимодействуете с переменной, вы можете не сразу вспомнить имя метки, но вы можете вспомнить, что это метка. Например, вы не уверены, назвали ли вы `lastNameLabel` или `familyNameLabel`.
Сначала назовите переменную из наиболее распространенного элемента следующим образом:
let labelNameFirst; let labelNameLast; let labelAge; let labelAddressLine1; let labelAddressLine2; let labelAddressLine3;
Ваш мозг будет думать следующим образом:
а. Это ярлык.
б. Этот ярлык должен быть связан с именем.
Когда вы начнете вводить `метку`, редактор/IDE будет фильтровать `метку`, а он фильтрует `метку` с `Именем`, логичнее думать и фильтровать в одном мире.
7. Используйте слова как можно короче:
Иногда мы используем разные слова для одного и того же значения: `фамилия`, `фамилия`, `фамилия`. Как мы предлагали ранее, мы можем создать список словарей, чтобы он оставался постоянным, если нет ссылок или предпочтений, выберите самое короткое слово. В этом примере мы выберем «фамилию».
8. Используйте положительные словари, чтобы назвать переменные:
Можете ли вы догадаться, что означает этот код `!isNotDisconnected`? Это НЕ забавная задача, чтобы играть в мозголомку, особенно когда вы отлаживаете критическую проблему. Просто сделайте это просто: `!isConnected`.
9. Используйте специальные слова для комментирования кода:
Комментарии полезны, особенно полезные и доступные для поиска. Для облегчения поиска перед комментариями можно использовать следующие специальные слова, также вы всегда можете разработать собственный список для своей команды:
//NOTE //OPTIMIZE //TODO //HACK //XXX //FIXME //BUG
Наконец, чтобы показать все вместе, у нас есть простой пример, чтобы вы могли увидеть, как все работает вместе:
function userListFromDatabase(userName, password) { let allUserList = []; if (!DatabaseUtil.isDisconnected) { allUserList = DatabaseUtil.queryUserList(userName, password); } return allUserList; } // Please remember to handle the database is not connected. userTable.display(userListFromDatabase(‘userName’, ‘password’));
⬇️
function getUserListFromDB(aUserName, aPassword) { let rAllUserList = []; if (DBUtil.connected) { rAllUserList = DBUtil.getUserList(aUserName, aPassword); } return rAllUserList; } // TODO: Handle the database is not connected. tableUser.display(getUserListFromDB(‘userName’, ‘password’));
Вот и все. ;) Удачного кодирования!