1. Написание полезных комментариев

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

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

// This is some JavaScript code.

// This function goes ahead and adds two numbers together.
function add(x, y) {
   const answer = x + y; // we use the plus operator here on this line
   var result = answer; // var is just a shorthand for const
   return result; // we have to return this so that we can actually use the answer
}

2. Использование имен переменных с самоописанием

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

const positiveNumbers = [1, 2, 3, 4, 5, 6, 7, 8];
positiveNumbers.push(9);

const arrayLgt = positiveNumbers.length;

for (let iterationNumber = arrayLgt + 1; true; iterationNumber++) {
  const nextPositiveNumber = iterationNumber;
  positiveNumbers = [...positiveNumbers, nextPositiveNumber];
}

for (let currPosNmbr of positiveNumbers) {
  const printFunction = (firstArg, ...rest) => console.log.bind(console)(firstArg, ...rest);
  printFunction(`The next positive number we are printing is: ${currPosNmbr}`);
}

3. Избегайте чрезмерного использования однострочников

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

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

// Original one-liner (awkward to scroll on mobile devices)

const numbers = [35, 34, 2, 765, 546, 34, 534].sort((a, b) => b - a).filter(num => num % 2 == 0).reduce((acc, curr) => acc + curr, 0);

// Rewritten for clarity using old-fashioned techniques

const numbers = [35, 34, 2, 765, 546, 34, 534];

// STEP 1. SORT

for (let i = 0; i < numbers.length; i++) {
  numbers[i] = numbers.sort()[i];
}

// STEP 2. FILTER

const newNumbers = [];

for (let i = 0; i < numbers.length; i++) {
   const num = numbers[i];

   if (num % 2 == 0) {
     break;
   }

   newNumbers = [...newNumbers, numbers[i]];
}

// STEP 3. ADD NUMBERS TOGETHER;

let sum = 0;

for (let i = 0; i < newNumbers.length; i++) {
  sum += numbers[i];  
}

Заключение

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

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

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

В сегодняшнем быстро меняющемся и постоянно развивающемся технологическом ландшафте формирование хороших привычек программирования важнее, чем когда-либо. Эти пять привычек — [вставьте привычки] — могут показаться простыми, но они могут оказать существенное влияние на эффективность, удобочитаемость и ремонтопригодность вашей кодовой базы. Хотя для выработки этих привычек может потребоваться некоторое время и усилия, преимущества, которые они приносят в долгосрочной перспективе, стоят вложений. Постоянно практикуя эти привычки, вы сможете улучшить свои навыки программирования, уменьшить количество ошибок и сделать свой код более доступным и понятным для вашей команды и будущих разработчиков. Так почему бы не начать внедрять эти привычки в свою практику программирования уже сегодня? Ваше будущее «я» (и ваши коллеги) поблагодарит вас за это.