Для новичка, для народа.

Если вы потратили какое-то время на написание кода, вы, вероятно, слышали что-то вроде «Хороший код самодокументируется». Людям нравится распространять эту фразу, но не все знают, что она означает.

Что такое самодокументирующийся код?

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

Давайте рассмотрим несколько примеров кода и рассмотрим плюсы и минусы каждого из них.

Пример 1:

const sWPA = [
 {
    n: “H.S.”,
    o: “S.”,
    a: “R.A.”
 },
 {
    n: “D.V.”,
    o: “S.L.”,
    a: “G.E.”
 },
 {
    n: “S.T.”,
    o: “G.S.”,
    a: “G.E.”
 }
]

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

Пример 2:

const starWarsPeopleArray = [
 {
    name: “Han Solo”,
    occupation: “Smuggler”,
    alliance: “Rebel Alliance”
 },
 {
    name: “Darth Vader”,
    occupation: “Sith Lord”,
    alliance: “Galactic Empire”
 },
 {
    name: “Shock Trooper”,
    occupation: “Galactic Soldier”,
    alliance: “Galactic Empire”
 }
]
printLoyalty(starWarsPeopleArray)

В примере 2 все четко и лаконично. Аббревиатур нет, и мы точно знаем, что все означает. Это ХОРОШАЯ практика. Если вы воспользуетесь ярлыками, вы и ваша команда обязательно столкнетесь с проблемами. Предотвратите это, уделив время тому, чтобы сделать это правильно.

Давайте реализуем то, что мы узнали!

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

function pL(arr){
   for(let i = 0; i < arr.length; i++){
 ‏‏‎       if(arr[i].a === “G.E.”){
 ‏‏        ‏‎ console.log(arr[i].n + “ “ + “is evil”)
 ‏‏‎             ‏‏‎‏‏‎} else {
 ‏‏‎ ‏        console.log(arr[i].n + “ “ + “will destroy the Empire”)
        }
    }
}
pL(sWPA)

Надеюсь, вы смогли взглянуть на этот фрагмент и применить то, что узнали сегодня.

Общие советы
Есть много способов написать код. Тем не менее, есть хорошие, лучшие и лучшие практики.

Подумайте, как потенциальные работодатели могут судить о вашем кодексе, какие вопросы они зададут себе?

«Они слишком много комментируют, чтобы объяснить свой код?»
«Легко ли читать этот код?»
«Имеет ли смысл название этой функции?»
«Захотят ли члены команды работать с этим кодом?»

Подумайте, как вы объясните свой код, когда столкнетесь с ошибками, которые необходимо исправить. Объяснить ошибку намного проще, если она написана просто и аккуратно.